Skip to content

Commit 3812780

Browse files
committed
fix javadoc issues
1 parent 18699c7 commit 3812780

File tree

3 files changed

+19
-8
lines changed

3 files changed

+19
-8
lines changed

core/src/main/java/com/microsoft/applicationinsights/TelemetryClient.java

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ public void trackTrace(TraceTelemetry telemetry) {
213213
/**
214214
* Sends a numeric metric to Application Insights. Appears in customMetrics in Analytics, and under Custom Metrics in Metric Explorer.
215215
* @param name The name of the metric. Max length 150.
216-
* @param value The value of the metric. Average if based on more than one sample count. Should be > 0.
216+
* @param value The value of the metric. Average if based on more than one sample count. Should be greater than 0.
217217
* @param sampleCount The sample count.
218218
* @param min The minimum value of the sample.
219219
* @param max The maximum value of the sample.
@@ -245,7 +245,7 @@ public void trackMetric(String name, double value, int sampleCount, double min,
245245
/**
246246
* Sends a numeric metric to Application Insights. Appears in customMetrics in Analytics, and under Custom Metrics in Metric Explorer.
247247
* @param name The name of the metric. Max length 150.
248-
* @param value The value of the metric. Should be > 0.
248+
* @param value The value of the metric. Should be greater than 0.
249249
*/
250250
public void trackMetric(String name, double value) {
251251
trackMetric(name, value, 1, value, value, null);
@@ -319,8 +319,10 @@ public void trackHttpRequest(String name, Date timestamp, long duration, String
319319

320320

321321
/**
322-
* Sends a request record to Application Insights. Appears in "requests" in Search and Analytics,
322+
* Sends a request record to Application Insights. Appears in "requests" in Search and Analytics,
323323
* and contributes to metric charts such as Server Requests, Server Response Time, Failed Requests.
324+
*
325+
* @param request request
324326
*/
325327
public void trackRequest(RequestTelemetry request) {
326328
track(request);
@@ -333,10 +335,10 @@ public void trackDependency(String dependencyName, String commandName, Duration
333335
}
334336

335337
/**
336-
* Sends a dependency record to Application Insights. Appears in "dependencies" in Search and Analytics.
337-
* Set device type == "PC" to have the record contribute to metric charts such as
338+
* Sends a dependency record to Application Insights. Appears in "dependencies" in Search and Analytics.
339+
* Set device type == "PC" to have the record contribute to metric charts such as
338340
* Server Dependency Calls, Dependency Response Time, and Dependency Failures.
339-
*
341+
* @param telemetry telemetry
340342
*/
341343
public void trackDependency(RemoteDependencyTelemetry telemetry) {
342344
if (isDisabled()) {

core/src/main/java/com/microsoft/applicationinsights/internal/channel/sampling/AdaptiveTelemetrySampler.java

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,16 @@ public synchronized void stop(long timeout, TimeUnit timeUnit) {
154154
}
155155

156156
/**
157-
* This method must be called prior to any use of the instance.
157+
* This method must be called prior to any use of the instance
158+
*
159+
* @param maxTelemetriesPerSecond maxTelemetriesPerSecond
160+
* @param evaluationIntervalInSeconds evaluationIntervalInSeconds
161+
* @param samplingPercentageDecreaseTimeoutInSeconds samplingPercentageDecreaseTimeoutInSeconds
162+
* @param samplingPercentageIncreaseTimeoutInSeconds samplingPercentageIncreaseTimeoutInSeconds
163+
* @param minSamplingPercentage minSamplingPercentage
164+
* @param maxSamplingPercentage maxSamplingPercentage
165+
* @param initialSamplingPercentage initialSamplingPercentage
166+
* @param movingAverageRatio movingAverageRatio
158167
*/
159168
public void initialize(String maxTelemetriesPerSecond,
160169
String evaluationIntervalInSeconds,

core/src/main/java/com/microsoft/applicationinsights/telemetry/MetricTelemetry.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ public Integer getCount() {
111111

112112
/**
113113
* Sets the number of samples for this metric.
114-
* @param count Number of samples. >= 1
114+
* @param count Number of samples greater than or equal to 1
115115
*/
116116
public void setCount(Integer count) {
117117
metric.setCount(count); updateKind();

0 commit comments

Comments
 (0)