phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[doc] Fix javadoc links after moving Rule

Browse Source
This commit is contained in:
Andreas Dangel
2024-02-09 14:47:15 +01:00
parent 2a3128fb86
commit a9c0ee0cd7
3 changed files with 17 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/pages/pmd/devdocs/writing_documentation.md
View File

@ -66,20 +66,20 @@ We have some additional custom liquid tags that help in writing the documentatio
Here's a short overview:
| Liquid | Rendered as |
|:-------|:------------|
| `{% raw %}{% rule "java/codestyle/LinguisticNaming" %}{% endraw %}` | {% rule "java/codestyle/LinguisticNaming" %} |
| `{% raw %}{% jdoc core::Rule %}{% endraw %}` | {% jdoc core::Rule %} |
| `{% raw %}{% jdoc !q!core::Rule %}{% endraw %}` | {% jdoc !q!core::Rule %} |
| `{% raw %}{% jdoc core::Rule#setName(java.lang.String) %}{% endraw %}` | {% jdoc core::Rule#setName(java.lang.String) %} |
| `{% raw %}{% jdoc !c!core::Rule#setName(java.lang.String) %}{% endraw %}` | {% jdoc !c!core::Rule#setName(java.lang.String) %} |
| `{% raw %}{% jdoc !a!core::Rule#setName(java.lang.String) %}{% endraw %}` | {% jdoc !a!core::Rule#setName(java.lang.String) %} |
| `{% raw %}{% jdoc !ac!core::Rule#setName(java.lang.String) %}{% endraw %}` | {% jdoc !ac!core::Rule#setName(java.lang.String) %} |
| `{% raw %}{% jdoc core::properties.PropertyDescriptor %}{% endraw %}` | {% jdoc core::properties.PropertyDescriptor %} |
| `{% raw %}{% jdoc_nspace :jast java::lang.java.ast %}{% jdoc jast::ASTTypeDeclaration %}{% endraw %}` | {% jdoc_nspace :jast java::lang.java.ast %}{% jdoc jast::ASTTypeDeclaration %} |
| `{% raw %}{% jdoc_nspace :jast java::lang.java.ast %}{% jdoc_package :jast %}{% endraw %}` | {% jdoc_nspace :jast java::lang.java.ast %}{% jdoc_package :jast %} |
| Liquid | Rendered as |
|:---------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------|
| `{% raw %}{% rule "java/codestyle/LinguisticNaming" %}{% endraw %}` | {% rule "java/codestyle/LinguisticNaming" %} |
| `{% raw %}{% jdoc core::lang.rule.Rule %}{% endraw %}` | {% jdoc core::lang.rule.Rule %} |
| `{% raw %}{% jdoc !q!core::lang.rule.Rule %}{% endraw %}` | {% jdoc !q!core::lang.rule.Rule %} |
| `{% raw %}{% jdoc core::lang.rule.Rule#setName(java.lang.String) %}{% endraw %}` | {% jdoc core::lang.rule.Rule#setName(java.lang.String) %} |
| `{% raw %}{% jdoc !c!core::lang.rule.Rule#setName(java.lang.String) %}{% endraw %}` | {% jdoc !c!core::lang.rule.Rule#setName(java.lang.String) %} |
| `{% raw %}{% jdoc !a!core::lang.rule.Rule#setName(java.lang.String) %}{% endraw %}` | {% jdoc !a!core::lang.rule.Rule#setName(java.lang.String) %} |
| `{% raw %}{% jdoc !ac!core::lang.rule.Rule#setName(java.lang.String) %}{% endraw %}` | {% jdoc !ac!core::lang.rule.Rule#setName(java.lang.String) %} |
| `{% raw %}{% jdoc core::properties.PropertyDescriptor %}{% endraw %}` | {% jdoc core::properties.PropertyDescriptor %} |
| `{% raw %}{% jdoc_nspace :jast java::lang.java.ast %}{% jdoc jast::ASTTypeDeclaration %}{% endraw %}` | {% jdoc_nspace :jast java::lang.java.ast %}{% jdoc jast::ASTTypeDeclaration %} |
| `{% raw %}{% jdoc_nspace :jast java::lang.java.ast %}{% jdoc_package :jast %}{% endraw %}` | {% jdoc_nspace :jast java::lang.java.ast %}{% jdoc_package :jast %} |
| `{% raw %}{% jdoc_nspace :PrD core::properties.PropertyDescriptor %}{% jdoc !ac!:PrD#uiOrder() %}{% endraw %}` | {% jdoc_nspace :PrD core::properties.PropertyDescriptor %}{% jdoc !ac!:PrD#uiOrder() %} |
| `{% raw %}{% jdoc_old core::Rule %}{% endraw %}` | {% jdoc_old core::Rule %}
| `{% raw %}{% jdoc_old core::Rule %}{% endraw %}` | {% jdoc_old core::Rule %} |
For the javadoc tags, the standard PMD maven modules are already defined as namespaces, e.g. `core`, `java`, `apex`, ....

8
docs/pages/pmd/userdocs/extending/writing_java_rules.md
View File

@ -32,7 +32,7 @@ very similar for other languages.
To write a rule in Java you'll have to:
1. Write a Java class that implements the interface {% jdoc core::Rule %}. Each
1. Write a Java class that implements the interface {% jdoc core::lang.rule.Rule %}. Each
language implementation provides a base rule class to ease your pain,
e.g. {% jdoc jrule::AbstractJavaRule %}.
2. Compile this class, linking it to PMD APIs (e.g. using PMD as a Maven dependency)
@ -247,11 +247,11 @@ For each thread, a deep copy of the rule is created. Each thread is given
a different set of files to analyse. Then, for each such file and for each
rule copy:
1. {% jdoc core::Rule#start(core::RuleContext) %} is called once, before parsing
2. {% jdoc core::Rule#apply(core::lang.ast.Node,core::RuleContext) %} is called with the root
1. {% jdoc core::lang.rule.Rule#start(core::RuleContext) %} is called once, before parsing
2. {% jdoc core::lang.rule.Rule#apply(core::lang.ast.Node,core::RuleContext) %} is called with the root
of the AST. That method performs the AST traversal that ultimately calls visit methods.
It's not called for RuleChain rules.
3. {% jdoc core::Rule#end(core::RuleContext) %} is called when the rule is done processing
3. {% jdoc core::lang.rule.Rule#end(core::RuleContext) %} is called when the rule is done processing
the file
## Example projects

1
docs/pages/release_notes.md
View File

@ -242,7 +242,6 @@ in the migration guide for details.
* {%jdoc core::lang.rule.RulePriority %}
* {%jdoc core::lang.rule.RuleSet %}
* {%jdoc core::lang.rule.RuleSetFactory %}
* {%jdoc core::lang.rule.RuleSetFactoryCompatibility %}
* {%jdoc core::lang.rule.RuleSetLoader %}
* {%jdoc core::lang.rule.RuleSetLoadException %}
* {%jdoc core::lang.rule.RuleSetWriter %}