Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: ParselyTracker comments to Javadoc style #71

Merged
merged 6 commits into from
Sep 15, 2023
Merged

docs: ParselyTracker comments to Javadoc style #71

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6f0200f
docs: ParselyTracker comments to Javadoc style
wzieba Sep 14, 2023
05b5732
docs: ParselyMetadata comments to Javadoc style
wzieba Sep 14, 2023
821facf
docs: ParselyVideoMetadata comments to Javadoc style
wzieba Sep 14, 2023
7698d47
build: add javadoc.jar to release artifacts
wzieba Sep 15, 2023
cd3aa1d
build: increase max metaspace size
wzieba Sep 15, 2023
389186d
ci: publish build artifacts to Github Actions
wzieba Sep 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 18 additions & 15 deletions parsely/src/main/java/com/parsely/parselyandroid/ParselyMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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.
*/
Expand Down