Fix #649: Properly escape @ in JavaDoc. (#651)

Signed-off-by: dblock <[email protected]>
opensearch-project · May 6, 2021 · 4d9356e · 4d9356e
1 parent 4892a38
commit 4d9356e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/server/src/main/java/org/opensearch/plugins/AnalysisPlugin.java b/server/src/main/java/org/opensearch/plugins/AnalysisPlugin.java
@@ -60,14 +60,14 @@
  * An additional extension point for {@link Plugin}s that extends OpenSearch's analysis functionality. To add an additional
  * {@link TokenFilter} just implement the interface and implement the {@link #getTokenFilters()} method:
  *
- * <pre>{@code
+ * <pre>
  * public class AnalysisPhoneticPlugin extends Plugin implements AnalysisPlugin {
  *     &#64;Override
- *     public Map<String, AnalysisProvider<TokenFilterFactory>> getTokenFilters() {
+ *     public Map&#60;String, AnalysisProvider&#60;TokenFilterFactory&#62;&#62; getTokenFilters() {
  *         return singletonMap("phonetic", PhoneticTokenFilterFactory::new);
  *     }
  * }
- * }</pre>
+ * </pre>
  *
  * OpenSearch doesn't have any automatic mechanism to share these components between indexes. If any component is heavy enough to warrant
  * such sharing then it is the Plugin's responsibility to do it in their {@link AnalysisProvider} implementation. We recommend against doing

diff --git a/server/src/main/java/org/opensearch/plugins/DiscoveryPlugin.java b/server/src/main/java/org/opensearch/plugins/DiscoveryPlugin.java
@@ -49,14 +49,14 @@
  * An additional extension point for {@link Plugin}s that extends OpenSearch's discovery functionality. To add an additional
  * {@link NetworkService.CustomNameResolver} just implement the interface and implement the {@link #getCustomNameResolver(Settings)} method:
  *
- * <pre>{@code
+ * <pre>
  * public class MyDiscoveryPlugin extends Plugin implements DiscoveryPlugin {
  *     &#64;Override
  *     public NetworkService.CustomNameResolver getCustomNameResolver(Settings settings) {
  *         return new YourCustomNameResolverInstance(settings);
  *     }
  * }
- * }</pre>
+ * </pre>
  */
 public interface DiscoveryPlugin {