changed order preprocessors, comment first

Jolanrensen · Jan 10, 2025 · ac13b3a · ac13b3a
1 parent d861472
commit ac13b3a
Show file tree

Hide file tree

Showing 10 changed files with 5 additions and 9 deletions.
diff --git a/kodex-common/src/main/kotlin/nl/jolanrensen/kodex/defaultProcessors/CommentDocProcessor.kt b/kodex-common/src/main/kotlin/nl/jolanrensen/kodex/defaultProcessors/CommentDocProcessor.kt
@@ -33,10 +33,6 @@ const val COMMENT_DOC_PROCESSOR = "nl.jolanrensen.kodex.defaultProcessors.Commen
  * * @otherTag This is not a comment
  * */
  * ```
- *
- * NOTE: Careful combining it with [IncludeDocProcessor] as it might remove content in the place
- * where kdoc with a @comment tag is requested to be included. Use inline tags to prevent this.
- * That said, @comment tags might also be useful to break up doc tag blocks, such as @setArg.
  */
 class CommentDocProcessor : TagDocProcessor() {
 

diff --git a/kodex-common/src/main/kotlin/nl/jolanrensen/kodex/defaultProcessors/IncludeDocProcessor.kt b/kodex-common/src/main/kotlin/nl/jolanrensen/kodex/defaultProcessors/IncludeDocProcessor.kt
@@ -70,7 +70,7 @@ const val INCLUDE_DOC_PROCESSOR_PRE_SORT = "$INCLUDE_DOC_PROCESSOR.PRE_SORT"
  *
  * File A:
  * ```kotlin
- * /** NOTE: The {@getArg operation} operation is part of the public API. */
+ * /** NOTE: The {@get operation} operation is part of the public API. */
  *  internal interface ApiNote
  * ```
  *

diff --git a/kodex-example-gradle-project-multiplatform/.gradle/8.5/checksums/checksums.lock b/kodex-example-gradle-project-multiplatform/.gradle/8.5/checksums/checksums.lock
diff --git a/kodex-example-gradle-project-multiplatform/.gradle/8.5/checksums/sha1-checksums.bin b/kodex-example-gradle-project-multiplatform/.gradle/8.5/checksums/sha1-checksums.bin
diff --git a/...adle-project-multiplatform/.gradle/8.5/dependencies-accessors/dependencies-accessors.lock b/...adle-project-multiplatform/.gradle/8.5/dependencies-accessors/dependencies-accessors.lock
diff --git a/kodex-example-gradle-project-multiplatform/.gradle/8.5/fileHashes/fileHashes.lock b/kodex-example-gradle-project-multiplatform/.gradle/8.5/fileHashes/fileHashes.lock
diff --git a/...x-example-gradle-project-multiplatform/.gradle/buildOutputCleanup/buildOutputCleanup.lock b/...x-example-gradle-project-multiplatform/.gradle/buildOutputCleanup/buildOutputCleanup.lock
diff --git a/kodex-example-gradle-project-multiplatform/.gradle/buildOutputCleanup/outputFiles.bin b/kodex-example-gradle-project-multiplatform/.gradle/buildOutputCleanup/outputFiles.bin
diff --git a/kodex-gradle-plugin/src/main/kotlin/nl/jolanrensen/kodex/gradle/CommonKodexTaskProperties.kt b/kodex-gradle-plugin/src/main/kotlin/nl/jolanrensen/kodex/gradle/CommonKodexTaskProperties.kt
@@ -64,10 +64,10 @@ interface CommonKodexTaskProperties {
      * `"com.example.plugin.MyProcessor"`
      *
      * Defaults to:
-     * [[INCLUDE_DOC_PROCESSOR],
+     * [[COMMENT_DOC_PROCESSOR],
+     *  [INCLUDE_DOC_PROCESSOR],
      *  [INCLUDE_FILE_DOC_PROCESSOR],
      *  [ARG_DOC_PROCESSOR],
-     *  [COMMENT_DOC_PROCESSOR],
      *  [SAMPLE_DOC_PROCESSOR],
      *  [EXPORT_AS_HTML_DOC_PROCESSOR],
      *  [REMOVE_ESCAPE_CHARS_PROCESSOR]]
@@ -206,10 +206,10 @@ fun CommonKodexTaskProperties.applyConventions(project: Project, factory: Object
     processLimit.convention(10_000)
     processors.convention(
         listOf(
+            COMMENT_DOC_PROCESSOR,
             INCLUDE_DOC_PROCESSOR,
             INCLUDE_FILE_DOC_PROCESSOR,
             ARG_DOC_PROCESSOR,
-            COMMENT_DOC_PROCESSOR,
             SAMPLE_DOC_PROCESSOR,
             EXPORT_AS_HTML_DOC_PROCESSOR,
             REMOVE_ESCAPE_CHARS_PROCESSOR,

diff --git a/kodex-intellij-plugin/src/main/resources/META-INF/plugin.xml b/kodex-intellij-plugin/src/main/resources/META-INF/plugin.xml
@@ -9,10 +9,10 @@
     For now, the order of default processors is unconfigurable, but this will be added in the future.<br>
     The order is like the recommended order:
     <ul>
+      <li><code>COMMENT_DOC_PROCESSOR</code>: The <code>@comment</code> processor</li>
       <li><code>INCLUDE_DOC_PROCESSOR</code>: The <code>@include</code> processor</li>
       <li><code>INCLUDE_FILE_DOC_PROCESSOR</code>: The <code>@includeFile</code> processor</li>
       <li><code>ARG_DOC_PROCESSOR</code>: The <code>@set</code> and <code>@get</code> / <code>$</code> processor. This runs <code>@set</code> first and then <code>@get</code> / <code>$</code></li>
-      <li><code>COMMENT_DOC_PROCESSOR</code>: The <code>@comment</code> processor</li>
       <li><code>SAMPLE_DOC_PROCESSOR</code>: The <code>@sample</code> and <code>@sampleNoComments</code> processor</li>
       <li><code>EXPORT_AS_HTML_DOC_PROCESSOR</code>: The <code>@exportAsHtmlStart</code> and <code>@exportAsHtmlEnd</code> tags for <code>@ExportAsHtml</code></li>
       <li><code>REMOVE_ESCAPE_CHARS_PROCESSOR</code>: The processor that removes escape characters</li>