Skip to content

Commit 8a289f7

Browse files
Copilottrask
andauthored
Copyedit JavaDoc documentation (#83)
* Initial plan * Add comprehensive JavaDoc and fix copyediting issues Co-authored-by: trask <[email protected]> * Remove new JavaDoc, keep only copyediting fixes Co-authored-by: trask <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: trask <[email protected]>
1 parent 91cf955 commit 8a289f7

File tree

7 files changed

+10
-10
lines changed

7 files changed

+10
-10
lines changed

agent/runtime-attach/src/main/java/com/microsoft/applicationinsights/attach/ApplicationInsights.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
public final class ApplicationInsights {
2323

2424
/**
25-
* This property allows configuring an Application Insights json file. It can be helpful to get an
26-
* Application Insights json file by Spring profile.
25+
* This property allows configuring an Application Insights JSON file. It can be helpful to load
26+
* different Application Insights JSON files based on Spring profile.
2727
*/
2828
public static final String APPLICATIONINSIGHTS_RUNTIME_ATTACH_CONFIGURATION_FILE =
2929
"applicationinsights.runtime-attach.configuration.classpath.file";
@@ -42,7 +42,7 @@ private ApplicationInsights() {}
4242
* Attach the Application Insights agent for Java to the current JVM. The attachment must be
4343
* requested at the beginning of the main method.
4444
*
45-
* @throws ConfigurationException If the file given by the
45+
* @throws ConfigurationException if the file specified by the
4646
* applicationinsights.runtime-attach.configuration.classpath.file property was not found
4747
*/
4848
public static void attach() {

classic-sdk/core/src/main/java/com/microsoft/applicationinsights/telemetry/AvailabilityTelemetry.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public void setMessage(String message) {
6363
data.setMessage(message);
6464
}
6565

66-
/** Gets a dictionary of custom defined metrics. */
66+
/** Gets a map of custom defined metrics. */
6767
public ConcurrentMap<String, Double> getMetrics() {
6868
return data.getMeasurements();
6969
}

classic-sdk/core/src/main/java/com/microsoft/applicationinsights/telemetry/BaseTelemetry.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public TelemetryContext getContext() {
3939
}
4040

4141
/**
42-
* Gets a dictionary of application-defined property names and values providing additional
42+
* Gets a map of application-defined property names and values providing additional
4343
* information about this event.
4444
*/
4545
@Override

classic-sdk/core/src/main/java/com/microsoft/applicationinsights/telemetry/EventTelemetry.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public void setName(String name) {
4040
data.setName(name);
4141
}
4242

43-
/** Gets a dictionary of custom defined metrics. */
43+
/** Gets a map of custom defined metrics. */
4444
public ConcurrentMap<String, Double> getMetrics() {
4545
return data.getMeasurements();
4646
}

classic-sdk/core/src/main/java/com/microsoft/applicationinsights/telemetry/ExceptionTelemetry.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public SeverityLevel getSeverityLevel() {
7373
: SeverityLevel.values()[data.getSeverityLevel().getValue()];
7474
}
7575

76-
/** Gets a dictionary of custom defined metrics. */
76+
/** Gets a map of custom defined metrics. */
7777
public ConcurrentMap<String, Double> getMetrics() {
7878
return data.getMeasurements();
7979
}

classic-sdk/core/src/main/java/com/microsoft/applicationinsights/telemetry/PageViewTelemetry.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public void setDuration(long duration) {
5959
data.setDuration(duration);
6060
}
6161

62-
/** Gets a dictionary of custom defined metrics. */
62+
/** Gets a map of custom defined metrics. */
6363
public ConcurrentMap<String, Double> getMetrics() {
6464
return data.getMeasurements();
6565
}

classic-sdk/core/src/main/java/com/microsoft/applicationinsights/telemetry/TelemetryContext.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,12 +123,12 @@ public String getInstrumentationKey() {
123123
return null;
124124
}
125125

126-
/** Gets a dictionary of application-defined property values. */
126+
/** Gets a map of application-defined property values. */
127127
public ConcurrentMap<String, String> getProperties() {
128128
return properties;
129129
}
130130

131-
/** Gets a dictionary of context tags. */
131+
/** Gets a map of context tags. */
132132
public ConcurrentMap<String, String> getTags() {
133133
return tags;
134134
}

0 commit comments

Comments
 (0)