hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

Update release notes

Browse Source 
Adjust the jdoc liquid tag to handle varargs
and constructors
This commit is contained in:
Clément Fournier
2020-07-01 11:45:11 +02:00
parent 49635c2a66
commit 835b9c7e5b
2 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/_plugins/javadoc_tag.rb
View File

@@ -36,6 +36,7 @@ require_relative 'jdoc_namespace_tag'
# * The (erased) types of method arguments must be fully qualified. This is the same
# convention as in javadoc {@link} tags, so you can use you're IDE's javadoc auto-
# complete and copy-paste. Namespaces also can be used for method arguments if they're from PMD.
# * Use the name <init> to reference a constructor
#
#
# * Defining custom namespaces
@@ -90,13 +91,15 @@ require_relative 'jdoc_namespace_tag'
# - Include spaces in any part of the reference
# - Use double or single quotes around the arguments
# - Use the "#" suffix to reference a nested type, instead, use a dot "." and reference it like a normal type name
# - Use `[]` instead of `...` for vararg parameters
# - Use the type name instead of `<init>` for a constructor
#
#
class JavadocTag < Liquid::Tag
QNAME_NO_NAMESPACE_REGEX = /((?:\w+\.)*\w+)/
ARG_REGEX = Regexp.new(Regexp.union(JDocNamespaceDeclaration::NAMESPACED_FQCN_REGEX, QNAME_NO_NAMESPACE_REGEX).source + '(\[\])*')
ARG_REGEX = Regexp.new(Regexp.union(JDocNamespaceDeclaration::NAMESPACED_FQCN_REGEX, QNAME_NO_NAMESPACE_REGEX).source + '(\[\])*(...)?')
ARGUMENTS_REGEX = Regexp.new('\(\)|\((' + ARG_REGEX.source + "(?:,(?:" + ARG_REGEX.source + "))*" + ')\)')
@@ -174,7 +177,7 @@ class JavadocTag < Liquid::Tag
def self.get_visible_name(opts, type_fqcn, member_suffix, is_package_ref, resolved_type)
# method or field
if member_suffix && Regexp.new('(\w+)(' + ARGUMENTS_REGEX.source + ")?") =~ member_suffix
if member_suffix && Regexp.new('(\w+|<init>)(' + ARGUMENTS_REGEX.source + ")?") =~ member_suffix
suffix = $1 # method or field name

10
docs/pages/release_notes.md
View File

@@ -18,6 +18,16 @@ This is a {{ site.pmd.release_type }} release.
### API Changes
#### Deprecated API
##### For removal
* {% jdoc core::lang.rule.RuleChainVisitor %} and all implementations in language modules
* {% jdoc core::lang.rule.AbstractRuleChainVisitor %}
* {% jdoc core::lang.Language#getRuleChainVisitorClass() %}
* {% jdoc core::lang.BaseLanguageModule#<init>(java.lang.String,java.lang.String,java.lang.String,java.lang.Class,java.lang.String...) %}
### External Contributions
{% endtocmaker %}