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

Fix Javadocs for release #281

Merged
merged 3 commits into from
Jun 27, 2023
Merged

Fix Javadocs for release #281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8680e26
Check that Javadocs build in CI
oppegard Jun 27, 2023
1092837
Fix Javadoc HTML errors
oppegard Jun 27, 2023
1e87661
Bump maven-javadoc-plugin to 3.5.0
oppegard Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/maven.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,6 @@ jobs:
distribution: 'temurin'
cache: maven
- name: Build with Maven
run: mvn -B package --file pom.xml
run: mvn --batch-mode --file pom.xml package
- name: Check Javadocs
run: mvn --batch-mode --file pom.xml --activate-profiles release org.apache.maven.plugins:maven-javadoc-plugin:jar
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.4.1</version>
<version>3.5.0</version>
<executions>
<execution>
<id>attach-javadocs</id>
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/wavefront/sdk/common/Utils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -653,9 +653,9 @@ public static Optional<String> getVersion(String artifactId) {
* {@code META-INF/}. The file should contain a line that specifies the project version as
* "project.version".
* Format of semantic version gauge value reported to Wavefront =
* <majorVersion>.<2-digit-minorVersion><2-digit-patchVersion>
* &lt;majorVersion&gt;.&lt;2-digit-minorVersion&gt;&lt;2-digit-patchVersion&gt;
*
* Ex: v2.6.1 => 2.0601
* Ex: v2.6.1 =&gt; 2.0601
*
* @param artifactId
* @return the version Gauge value for the given artifactId
Expand Down
40 changes: 20 additions & 20 deletions src/main/java/com/wavefront/sdk/common/clients/WavefrontClientFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ public WavefrontClientFactory addClient(WavefrontSender sender) {

/**
* Adds a new WavefrontSender that will either forward points to a proxy or directly to a Wavefront service.
* <br />
* <strong>proxy ingestion:</strong> <i>proxy://your.proxy.com:port</i> <br />
* <strong>direct ingestion:</strong> <i>https://token@yourCluster.wavefront.com</i> <br />
* <br />
* <br>
* <strong>proxy ingestion:</strong> <i>proxy://your.proxy.com:port</i> <br>
* <strong>direct ingestion:</strong> <i>https://token@yourCluster.wavefront.com</i> <br>
* <br>
*
* @param url The URL of either yourCluster or your.proxy.com
*
Expand All @@ -58,10 +58,10 @@ public WavefrontClientFactory addClient(String url) {

/**
* Adds a new WavefrontSender that will either forward points to a proxy or directly to a Wavefront service.
* <br />
* <strong>proxy ingestion:</strong> <i>proxy://your.proxy.com:port</i> <br />
* <strong>direct ingestion:</strong> <i>https://token@yourCluster.wavefront.com</i> <br />
* <br />
* <br>
* <strong>proxy ingestion:</strong> <i>proxy://your.proxy.com:port</i> <br>
* <strong>direct ingestion:</strong> <i>https://token@yourCluster.wavefront.com</i> <br>
* <br>
*
* @param url The URL of either yourCluster or your.proxy.com
* @param batchSize The total metrics, histograms, spans, or span logs to send in a single flush
Expand All @@ -77,10 +77,10 @@ public WavefrontClientFactory addClient(String url, @Nullable Integer batchSize,

/**
* Adds a new WavefrontSender that will either forward points to a proxy or directly to a Wavefront service.
* <br />
* <strong>proxy ingestion:</strong> <i>proxy://your.proxy.com:port</i> <br />
* <strong>direct ingestion:</strong> <i>https://token@yourCluster.wavefront.com</i> <br />
* <br />
* <br>
* <strong>proxy ingestion:</strong> <i>proxy://your.proxy.com:port</i> <br>
* <strong>direct ingestion:</strong> <i>https://token@yourCluster.wavefront.com</i> <br>
* <br>
*
* @param url The URL of either yourCluster or your.proxy.com
* @param batchSize The total metrics, histograms, spans, or span logs to send in a single flush
Expand All @@ -98,10 +98,10 @@ public WavefrontClientFactory addClient(String url, @Nullable Integer batchSize,

/**
* Adds a new WavefrontSender that will either forward points to a proxy or directly to a Wavefront service.
* <br />
* <strong>proxy ingestion:</strong> <i>proxy://your.proxy.com:port</i> <br />
* <strong>direct ingestion:</strong> <i>https://token@yourCluster.wavefront.com</i> <br />
* <br />
* <br>
* <strong>proxy ingestion:</strong> <i>proxy://your.proxy.com:port</i> <br>
* <strong>direct ingestion:</strong> <i>https://token@yourCluster.wavefront.com</i> <br>
* <br>
*
* @param url The URL of either yourCluster or your.proxy.com
* @param batchSize The total metrics, histograms, spans, or span logs to send in a single flush
Expand All @@ -124,10 +124,10 @@ public WavefrontClientFactory addClient(String url, @Nullable Integer batchSize,

/**
* Adds a new WavefrontSender that will either forward points to a proxy or directly to a Wavefront service.
* <br />
* <strong>proxy ingestion:</strong> <i>proxy://your.proxy.com:port</i> <br />
* <strong>direct ingestion:</strong> <i>https://token@yourCluster.wavefront.com</i> <br />
* <br />
* <br>
* <strong>proxy ingestion:</strong> <i>proxy://your.proxy.com:port</i> <br>
* <strong>direct ingestion:</strong> <i>https://token@yourCluster.wavefront.com</i> <br>
* <br>
*
* @param url The URL of either yourCluster or your.proxy.com
* @param batchSize The total metrics, histograms, spans, or span logs to send in a single flush
Expand Down