Skip to content

Issue #13626: Reused meta and xdoc functionality to gut annotation module javadocs#17675

Merged
romani merged 1 commit into
checkstyle:masterfrom
SteLeo1602:reuseMetadata
Sep 7, 2025
Merged

Issue #13626: Reused meta and xdoc functionality to gut annotation module javadocs#17675
romani merged 1 commit into
checkstyle:masterfrom
SteLeo1602:reuseMetadata

Conversation

@SteLeo1602

@SteLeo1602 SteLeo1602 commented Aug 23, 2025

Copy link
Copy Markdown
Contributor

Issue #13626
Continuation of #13670

Additionally, changed Xdoc implementation to remove quotations around properties' default values

@romani romani left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

items:

@SteLeo1602 SteLeo1602 changed the title Issue #13626: Gutted javadocs for meta and xdoc Issue #13626: Reused meta and xdoc functionality to gut javadocs Aug 26, 2025

@romani romani left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

items:

Comment thread src/main/java/com/puppycrawl/tools/checkstyle/site/SiteUtil.java Outdated
@SteLeo1602 SteLeo1602 force-pushed the reuseMetadata branch 3 times, most recently from 9f9f463 to 78403ba Compare August 29, 2025 06:07

@romani romani left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

more to restore:

@SteLeo1602 SteLeo1602 force-pushed the reuseMetadata branch 11 times, most recently from 2d5c311 to bf29208 Compare September 4, 2025 06:24
<td>Specify Xpath query.</td>
<td><a href="../../property_types.html#String">String</a></td>
<td><code>&quot;&quot;</code></td>
<td><code></code></td>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this actually good

Image

<td>Set the JDK version that you are using. Old JDK version numbering is supported (e.g. 1.8 for Java 8) as well as just the major JDK version alone (e.g. 8) is supported. This property only considers features from officially released Java versions as supported. Features introduced in preview releases are not considered supported until they are included in a non-preview release.</td>
<td><a href="../../property_types.html#String">String</a></td>
<td><code>&quot;22&quot;</code></td>
<td><code>22</code></td>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this also good in rendering

Image

@romani

romani commented Sep 4, 2025

Copy link
Copy Markdown
Member

lets limit updates to specific Modules or packages and lets make PR merge-able.
We should do migration to new code step by step

@SteLeo1602 SteLeo1602 changed the title Issue #13626: Reused meta and xdoc functionality to gut javadocs Issue #13626: Reused meta and xdoc functionality to gut annotation module javadocs Sep 4, 2025
@SteLeo1602 SteLeo1602 force-pushed the reuseMetadata branch 3 times, most recently from 4cc4676 to a4f3688 Compare September 5, 2025 06:12
@romani

romani commented Sep 5, 2025

Copy link
Copy Markdown
Member

conceptually code changes are good, lets make CI green to merge this most basic version of code to allow us migrate step by step

@SteLeo1602 SteLeo1602 force-pushed the reuseMetadata branch 3 times, most recently from 764f36c to 5f0d1b5 Compare September 7, 2025 00:14

@romani romani left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idea inspects need to be extended to allow new javadoc tag:

<option name="myAdditionalJavadocTags" value="noinspectionreason"/>

items:

Comment thread pom.xml
<rule>
<element>CLASS</element>
<includes>
<include>com.puppycrawl.tools.checkstyle.meta.MetadataGeneratorUtil</include>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

~/java/github/romani/checkstyle [SteLeo1602/reuseMetadata L|✚ 1] 
$ git diff
diff --git a/pom.xml b/pom.xml
index a248579e4c..d64e8281c5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -961,6 +961,7 @@
                              com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter.UpdatingTreeModelListener
                     </exclude>
                     <!-- Metadata Generator related classes -->
+                    <exclude>com.puppycrawl.tools.checkstyle.meta.MetadataGeneratorUtil</exclude>
                     <exclude>com.puppycrawl.tools.checkstyle.meta.ModuleDetails*</exclude>
                     <exclude>com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper*</exclude>
                     <exclude>com.puppycrawl.tools.checkstyle.meta.XmlMeta*</exclude>

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@SteLeo1602 SteLeo1602 force-pushed the reuseMetadata branch 2 times, most recently from 47aae39 to 5c7c6f8 Compare September 7, 2025 22:23

@romani romani left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will improve code later on, after migration is done

@romani romani merged commit 559c3fe into checkstyle:master Sep 7, 2025
120 checks passed
@SteLeo1602 SteLeo1602 deleted the reuseMetadata branch March 24, 2026 02:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants