Skip to content

[Backport] [3.x] Fix generating JavaDocs for the samples/ (#1749) #1751

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

Open
wants to merge 1 commit into
base: 3.x
Choose a base branch
from
+13 −12
Open

[Backport] [3.x] Fix generating JavaDocs for the samples/ (#1749) #1751

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Added support for the `knn` namespace ([#1693](https://github.com/opensearch-project/opensearch-java/pull/1693))
- Added getter for retrieve all nodes along with their state ([#1698](https://github.com/opensearch-project/opensearch-java/pull/1698))
- Added support for the `search_relevance` namespace ([#1748](https://github.com/opensearch-project/opensearch-java/pull/1748))
- Fix formatting of the main method to run for various samples ([#1749](https://github.com/opensearch-project/opensearch-java/pull/1749))

### Dependencies
- Bump `io.github.classgraph:classgraph` from 4.8.180 to 4.8.181 ([#1703](https://github.com/opensearch-project/opensearch-java/pull/1703))
Expand Down
2 changes: 1 addition & 1 deletion samples/src/main/java/org/opensearch/client/samples/Bulk.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
import org.opensearch.client.samples.util.IndexData;

/**
* Run with: <c>./gradlew :samples:run -Dsamples.mainClass=Bulk</c>
* Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=Bulk}
*/
public class Bulk {
private static final Logger LOGGER = LogManager.getLogger(Bulk.class);
Expand Down
2 changes: 1 addition & 1 deletion samples/src/main/java/org/opensearch/client/samples/DataStreamBasics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import org.opensearch.client.opensearch.indices.PutIndexTemplateRequest;

/**
* Run with: <c>./gradlew :samples:run -Dsamples.mainClass=DataStreamBasics</c>
* Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=DataStreamBasics}
*/
public class DataStreamBasics {
private static final Logger LOGGER = LogManager.getLogger(DataStreamBasics.class);
Expand Down
2 changes: 1 addition & 1 deletion samples/src/main/java/org/opensearch/client/samples/IndexTemplates.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import org.opensearch.client.opensearch.indices.PutIndexTemplateRequest;

/**
* Run with: <c>./gradlew :samples:run -Dsamples.mainClass=IndexTemplates</c>
* Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=IndexTemplates}
*/
public class IndexTemplates {
private static final Logger LOGGER = LogManager.getLogger(IndexTemplates.class);
Expand Down
2 changes: 1 addition & 1 deletion samples/src/main/java/org/opensearch/client/samples/IndexingBasics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
import org.opensearch.client.samples.util.IndexData;

/**
* Run with: <c>./gradlew :samples:run -Dsamples.mainClass=IndexingBasics</c>
* Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=IndexingBasics}
*/
public class IndexingBasics {
private static final Logger LOGGER = LogManager.getLogger(IndexingBasics.class);
Expand Down
2 changes: 1 addition & 1 deletion samples/src/main/java/org/opensearch/client/samples/PointInTime.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import org.opensearch.client.opensearch.indices.IndexSettings;

/**
* Run with: <c>./gradlew :samples:run -Dsamples.mainClass=PointInTime</c>
* Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=PointInTime}
*/
public class PointInTime {
private static final Logger LOGGER = LogManager.getLogger(PointInTime.class);
Expand Down
2 changes: 1 addition & 1 deletion samples/src/main/java/org/opensearch/client/samples/Search.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
import org.opensearch.client.samples.util.IndexData;

/**
* Run with: <c>./gradlew :samples:run -Dsamples.mainClass=Search</c>
* Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=Search}
*/
public class Search {
private static final Logger LOGGER = LogManager.getLogger(Search.class);
Expand Down
2 changes: 1 addition & 1 deletion samples/src/main/java/org/opensearch/client/samples/knn/KnnBasics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import org.opensearch.client.samples.util.RandUtil;

/**
* Run with: <c>./gradlew :samples:run -Dsamples.mainClass=knn.KnnBasics</c>
* Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=knn.KnnBasics}
*/
public class KnnBasics {
private static final Logger LOGGER = LogManager.getLogger(KnnBasics.class);
Expand Down
2 changes: 1 addition & 1 deletion samples/src/main/java/org/opensearch/client/samples/knn/KnnBooleanFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import org.opensearch.client.samples.util.RandUtil;

/**
* Run with: <c>./gradlew :samples:run -Dsamples.mainClass=knn.KnnBooleanFilter</c>
* Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=knn.KnnBooleanFilter}
*/
public class KnnBooleanFilter {
private static final Logger LOGGER = LogManager.getLogger(KnnBooleanFilter.class);
Expand Down
2 changes: 1 addition & 1 deletion samples/src/main/java/org/opensearch/client/samples/knn/KnnEfficientFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import org.opensearch.client.samples.SampleClient;

/**
* Run with: <c>./gradlew :samples:run -Dsamples.mainClass=knn.KnnEfficientFilter</c>
* Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=knn.KnnEfficientFilter}
*/
public class KnnEfficientFilter {
private static final Logger LOGGER = LogManager.getLogger(KnnEfficientFilter.class);
Expand Down
2 changes: 1 addition & 1 deletion samples/src/main/java/org/opensearch/client/samples/knn/KnnPainlessScript.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import org.opensearch.client.samples.util.RandUtil;

/**
* Run with: <c>./gradlew :samples:run -Dsamples.mainClass=knn.KnnPainlessScript</c>
* Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=knn.KnnPainlessScript}
*/
public class KnnPainlessScript {
private static final Logger LOGGER = LogManager.getLogger(KnnPainlessScript.class);
Expand Down
2 changes: 1 addition & 1 deletion samples/src/main/java/org/opensearch/client/samples/knn/KnnScriptScore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import org.opensearch.client.samples.util.RandUtil;

/**
* Run with: <c>./gradlew :samples:run -Dsamples.mainClass=knn.KnnScriptScore</c>
* Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=knn.KnnScriptScore}
*/
public class KnnScriptScore {
private static final Logger LOGGER = LogManager.getLogger(KnnScriptScore.class);
Expand Down
2 changes: 1 addition & 1 deletion samples/src/main/java/org/opensearch/client/samples/neural/NeuralSearch.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
import org.opensearch.client.samples.SampleClient;

/**
* Run with: <c>./gradlew :samples:run -Dsamples.mainClass=neural.NeuralSearch</c>
* Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=neural.NeuralSearch}
*/
public class NeuralSearch {
private static final String SAMPLE_NAME = "neural-search";
Expand Down
Loading