Merge pull request #71 from Parsely/issue/51_update_comments_to_follo…

…w_javadoc

.github/workflows/readme.yml

@@ -28,3 +28,8 @@ jobs:
           SIGNING_KEY_ID: ${{ secrets.SIGNING_KEY_ID }}
           SIGNING_PASSWORD: ${{ secrets.SIGNING_PASSWORD }}
           SIGNING_KEY: ${{ secrets.SIGNING_KEY }}
+      - name: Publish build artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: artifact
+          path: ~/.m2/repository/com/parsely/parsely/*

gradle.properties

@@ -11,6 +11,7 @@
 # The setting is particularly useful for tweaking memory settings.
 # Default value: -Xmx10248m -XX:MaxPermSize=256m
 # org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8
+org.gradle.jvmargs=-XX:MaxMetaspaceSize=2g
 
 # When configured, Gradle will run in incubating parallel mode.
 # This option should only be used with decoupled projects. More details, visit

parsely/build.gradle

@@ -26,6 +26,7 @@ android {
     publishing {
         singleVariant('release') {
             withSourcesJar()
+            withJavadocJar()
         }
     }
 }

parsely/src/main/java/com/parsely/parselyandroid/ParselyMetadata.java

@@ -7,27 +7,29 @@
 import java.util.HashMap;
 import java.util.Map;
 
-/*! \brief Represents post metadata to be passed to Parsely tracking.
- *
- *  This class is used to attach a metadata block to a Parse.ly pageview
- *  request. Pageview metadata is only required for URLs not accessible over the
- *  internet (i.e. app-only content) or if the customer is using an "in-pixel" integration.
- *  Otherwise, metadata will be gathered by Parse.ly's crawling infrastructure.
+/**
+ * Represents post metadata to be passed to Parsely tracking.
+ * <p>
+ * This class is used to attach a metadata block to a Parse.ly pageview
+ * request. Pageview metadata is only required for URLs not accessible over the
+ * internet (i.e. app-only content) or if the customer is using an "in-pixel" integration.
+ * Otherwise, metadata will be gathered by Parse.ly's crawling infrastructure.
  */
 public class ParselyMetadata {
     public ArrayList<String> authors, tags;
     public String link, section, thumbUrl, title;
     public Calendar pubDate;
 
-    /* \brief Create a new ParselyMetadata object.
+    /**
+     * Create a new ParselyMetadata object.
      *
-     * @param authors         The names of the authors of the content. Up to 10 authors are accepted.
-     * @param link            A post's canonical url.
-     * @param section         The category or vertical to which this content belongs.
-     * @param tags            User-defined tags for the content. Up to 20 are allowed.
-     * @param thumbUrl        URL at which the main image for this content is located.
-     * @param title           The title of the content.
-     * @param pubDate         The date this piece of content was published.
+     * @param authors  The names of the authors of the content. Up to 10 authors are accepted.
+     * @param link     A post's canonical url.
+     * @param section  The category or vertical to which this content belongs.
+     * @param tags     User-defined tags for the content. Up to 20 are allowed.
+     * @param thumbUrl URL at which the main image for this content is located.
+     * @param title    The title of the content.
+     * @param pubDate  The date this piece of content was published.
      */
     public ParselyMetadata(
             @Nullable ArrayList<String> authors,
@@ -47,7 +49,8 @@ public ParselyMetadata(
         this.pubDate = pubDate;
     }
 
-    /* \brief Turn this object into a Map
+    /**
+     * Turn this object into a Map
      *
      * @return a Map object representing the metadata.
      */