From 93565a5eb68b4eaf32fbf1123be162cc621944aa Mon Sep 17 00:00:00 2001 From: Ashley <73482956+ascopes@users.noreply.github.com> Date: Thu, 7 Mar 2024 08:51:42 +0000 Subject: [PATCH] Fix formatting of code snippets in JavaDocs --- .../AbstractGenerateMojo.java | 68 +++++++++---------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/src/main/java/io/github/ascopes/protobufmavenplugin/AbstractGenerateMojo.java b/src/main/java/io/github/ascopes/protobufmavenplugin/AbstractGenerateMojo.java index 094be420..ec33e786 100644 --- a/src/main/java/io/github/ascopes/protobufmavenplugin/AbstractGenerateMojo.java +++ b/src/main/java/io/github/ascopes/protobufmavenplugin/AbstractGenerateMojo.java @@ -117,17 +117,17 @@ public abstract class AbstractGenerateMojo extends AbstractMojo { * architecture is automatically generated and injected in the classifier if the classifier and * type are not provided explicitly. * - *

For example:
- * - *

-   *   <binaryMavenPlugins>
-   *     <binaryMavenPlugin>
-   *       <groupId>com.salesforce.servicelibs</groupId>
-   *       <artifactId>reactor-grpc</artifactId>
-   *       <version>1.2.4</version>
-   *     </binaryMavenPlugin>
-   *   </binaryMavenPlugins>
-   * 
+ *

For example: + * + *

{@code
+   *   
+   *     
+   *       com.salesforce.servicelibs
+   *       reactor-grpc
+   *       1.2.4
+   *     
+   *   
+   * }
* *

If you have a Java-based plugin that does not distribute a native * executable, or are using a more obscure system architecture, then using a @@ -141,13 +141,13 @@ public abstract class AbstractGenerateMojo extends AbstractMojo { /** * Binary plugins to use with the protobuf compiler, sourced from the system {@code PATH}. * - *

For example:
+ *

For example: * - *

-   *   <binaryPathPlugins>
-   *     <binaryPathPlugin>protoc-gen-grpc-java<binaryPathPlugin>
-   *   </binaryPathPlugins>
-   * 
+ *

{@code
+   *   
+   *     protoc-gen-grpc-java
+   *   
+   * }
* * @since 0.3.0 */ @@ -166,13 +166,13 @@ public abstract class AbstractGenerateMojo extends AbstractMojo { *
  • FTP resources, specified using {@code ftp://example.server/path/to/file}
  • * * - *

    For example:
    + *

    For example: * - *

    -   *   <binaryUrlPlugins>
    -   *     <binaryUrlPlugin>ftp://myorganisation.org/protoc/plugins/myplugin.exe<binaryUrlPlugin>
    -   *   </binaryUrlPlugins>
    -   * 
    + *

    {@code
    +   *   
    +   *     ftp://myorganisation.org/protoc/plugins/myplugin.exe
    +   *   
    +   * }
    * * @since 0.4.0 */ @@ -185,17 +185,17 @@ public abstract class AbstractGenerateMojo extends AbstractMojo { *

    Unlike artifact-based plugins, these are pure Java JAR applications that abide by the * protoc compiler API, and will be provided to the compiler via generated scripts. * - *

    For example:
    - * - *

    -   *   <jvmMavenPlugins>
    -   *     <jvmMavenPlugin>
    -   *       <groupId>com.salesforce.servicelibs</groupId>
    -   *       <artifactId>reactor-grpc</artifactId>
    -   *       <version>1.2.4</version>
    -   *     </jvmMavenPlugin>
    -   *   </jvmMavenPlugins>
    -   * 
    + *

    For example: + * + *

    {@code
    +   *   
    +   *     
    +   *       com.salesforce.servicelibs
    +   *       reactor-grpc
    +   *       1.2.4
    +   *     
    +   *   
    +   * }
    * *

    This mechanism allows plugin vendors to implement their plugins in * Java and just distribute platform-independent JAR instead.