[javadoc] fix issues with javadoc

DataDog · Jan 29, 2020 · b527293 · b527293
1 parent f3a81b6
commit b527293
Show file tree

Hide file tree

Showing 4 changed files with 203 additions and 26 deletions.
diff --git a/src/main/java/com/timgroup/statsd/Event.java b/src/main/java/com/timgroup/statsd/Event.java
@@ -75,6 +75,7 @@ private Builder() {}
 
         /**
          * Build factory method for the event.
+         * @return Event built following specified options.
          */
         public Event build() {
             if ((event.title == null) || event.title.isEmpty()) {
@@ -90,6 +91,7 @@ public Event build() {
          * Title for the event.
          * @param title
          *     Event title ; mandatory
+         * @return Builder object being used.
          */
         public Builder withTitle(final String title) {
             event.title = title;
@@ -100,6 +102,7 @@ public Builder withTitle(final String title) {
          * Text for the event.
          * @param text
          *     Event text ; supports line breaks ; mandatory
+         * @return Builder object being used.
          */
         public Builder withText(final String text) {
             event.text = text;
@@ -110,6 +113,7 @@ public Builder withText(final String text) {
          * Date for the event.
          * @param date
          *     Assign a timestamp to the event ; Default: none (Default is the current Unix epoch timestamp when not sent)
+         * @return Builder object being used.
          */
         public Builder withDate(final Date date) {
             event.millisSinceEpoch = date.getTime();
@@ -120,6 +124,7 @@ public Builder withDate(final Date date) {
          * Date for the event.
          * @param millisSinceEpoch
          *     Assign a timestamp to the event ; Default: none (Default is the current Unix epoch timestamp when not sent)
+         * @return Builder object being used.
          */
         public Builder withDate(final long millisSinceEpoch) {
             event.millisSinceEpoch = millisSinceEpoch;
@@ -130,6 +135,7 @@ public Builder withDate(final long millisSinceEpoch) {
          * Source hostname for the event.
          * @param hostname
          *     Assign a hostname to the event ; Default: none
+         * @return Builder object being used.
          */
         public Builder withHostname(final String hostname) {
             event.hostname = hostname;
@@ -140,6 +146,7 @@ public Builder withHostname(final String hostname) {
          * Aggregation key for the event.
          * @param aggregationKey
          *     Assign an aggregation key to the event, to group it with some others ; Default: none
+         * @return Builder object being used.
          */
         public Builder withAggregationKey(final String aggregationKey) {
             event.aggregationKey = aggregationKey;
@@ -150,6 +157,7 @@ public Builder withAggregationKey(final String aggregationKey) {
          * Priority for the event.
          * @param priority
          *     Can be "normal" or "low" ; Default: "normal"
+         * @return Builder object being used.
          */
         public Builder withPriority(final Priority priority) {
             //noinspection StringToUpperCaseOrToLowerCaseWithoutLocale
@@ -161,6 +169,7 @@ public Builder withPriority(final Priority priority) {
          * Source Type name for the event.
          * @param sourceTypeName
          *     Assign a source type to the event ; Default: none
+         * @return Builder object being used.
          */
         public Builder withSourceTypeName(final String sourceTypeName) {
             event.sourceTypeName = sourceTypeName;
@@ -171,6 +180,7 @@ public Builder withSourceTypeName(final String sourceTypeName) {
          * Alert type for the event.
          * @param alertType
          *     Can be "error", "warning", "info" or "success" ; Default: "info"
+         * @return Builder object being used.
          */
         public Builder withAlertType(final AlertType alertType) {
             //noinspection StringToUpperCaseOrToLowerCaseWithoutLocale

diff --git a/src/main/java/com/timgroup/statsd/NonBlockingStatsDClient.java b/src/main/java/com/timgroup/statsd/NonBlockingStatsDClient.java
@@ -165,10 +165,14 @@ protected NumberFormat initialValue() {
      *     the entity id value used with an internal tag for tracking client entity.
      *     If "entityID=null" the client default the value with the environment variable "DD_ENTITY_ID".
      *     If the environment variable is not defined, the internal tag is not added.
+     * @param poolSize
+     *     The size for the network buffer pool.
      * @param processorWorkers
      *     The number of processor worker threads assembling buffers for submission.
      * @param senderWorkers
      *     The number of sender worker threads submitting buffers to the socket.
+     * @param blocking
+     *     Blocking or non-blocking implementation for statsd message queue.
      * @throws StatsDClientException
      *     if the client could not be started
      */
@@ -1004,7 +1008,7 @@ public void serviceCheck(final ServiceCheck sc) {
     /**
      * Records a value for the specified set.
      *
-     * <p></p>Sets are used to count the number of unique elements in a group. If you want to track the number of
+     * <p>Sets are used to count the number of unique elements in a group. If you want to track the number of
      * unique visitor to your site, sets are a great way to do that.</p>
      *
      * <p>This method is a DataDog extension, and may not work with other servers.</p>