Maven 2.x Taglist Plugin

Regular expression support for tags

Details

  • Type: New Feature New Feature
  • Status: Reopened Reopened
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: 2.1
  • Fix Version/s: 2.4
  • Labels:
    None
  • Number of attachments :
    0

Description

Background: Modern IDEs offer code templates for new files or new methods. Also some code formatters add automatically template-based javadoc comments. Typically such templates use tags as placeholders for the real description which are located at the end of the line. Enhancing the standard tag detection to support EOL tags might trigger too many false positives, especially if the tag comment has to be extracted too.

Therefore this proposal is about the support of an extension to the configuration to support tags defined as regular expression:

<regexpTags>
    <regexpTag>\\* (.*)DOCUMENT_ME$<regexpTag>
<regexpTags>

The algorithm should match the regexp against each line. The first match of the line is the hit and the first group defines the text of the tag. In this situation you will avoid false positives for the standard tags and users like me can define advanced search patterns.

Background of this issue are the comments at MTAGLIST-17, see the attachment there for code with such tags.

Issue Links

is duplicated by

New Feature - A new feature of the product, which has yet to be developed. MTAGLIST-15 either support ignoring of casing for tags or implement tag-classes (clusters)

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Jörg Schaible added a comment -

Since I got the issue wrong and for some reasons normal JIRA users cannot create links to other issues here, again the corrected tag: MTAGLIST-17

Show
Jörg Schaible added a comment - Since I got the issue wrong and for some reasons normal JIRA users cannot create links to other issues here, again the corrected tag: MTAGLIST-17
Hide
Permalink
Nate Stoddard added a comment - - edited

Regular expression support is being added in MTAGLIST-15. There was a test patch uploaded that contains the new implementation. Please experiment with that patch to see if it meets your needs and does not have any problems when using your regular expressions.

Show
Nate Stoddard added a comment - - edited Regular expression support is being added in MTAGLIST-15 . There was a test patch uploaded that contains the new implementation. Please experiment with that patch to see if it meets your needs and does not have any problems when using your regular expressions.
Hide
Permalink
Jörg Schaible added a comment -

I'll reopen this issue, because the regex support that has been added does not produce any useful result for my case. It seems that in the current implementation the regex matches only a word and I cannot define the position of the tag's comment for the report.

In my proposal the regular expression had to match the complete line and defined a capturing group for the comment. The goal is to get a useful report over missing documentation (tags have been added by formatting tools) like in:

/**
 * A method's description.
 *
 * @param foo the foo param
 * @param bar DOCUMENT_ME
 * @throws IllegalArgumentException DOCUMENT_ME
 */
void aMethod(int foo, int bar) {
...

If I define DOCUMENT_ME as tag (with regEx or exact) the report will contain for each found tag simply "-- No comment --" which is quite useless. With my proposal I'd have "@param bar" for the first tag location and "@throws IllegalArgumentException" for the second.

Show
Jörg Schaible added a comment - I'll reopen this issue, because the regex support that has been added does not produce any useful result for my case. It seems that in the current implementation the regex matches only a word and I cannot define the position of the tag's comment for the report. In my proposal the regular expression had to match the complete line and defined a capturing group for the comment. The goal is to get a useful report over missing documentation (tags have been added by formatting tools) like in: /** * A method's description. * * @param foo the foo param * @param bar DOCUMENT_ME * @ throws IllegalArgumentException DOCUMENT_ME */ void aMethod( int foo, int bar) { ... If I define DOCUMENT_ME as tag (with regEx or exact) the report will contain for each found tag simply "-- No comment --" which is quite useless. With my proposal I'd have "@param bar" for the first tag location and "@throws IllegalArgumentException" for the second.

People

  • Assignee:
    David J. M. Karlsen
    Reporter:
    Jörg Schaible
Vote (2)
Watch (2)

Dates

  • Created:
    Updated: