GeoTools

Routine to update javadoc source tag

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 2.7.2, 8.0-M1
  • Component/s: None
  • Labels:
    None

Description

Modify the InsertSourceTag app in the build/maven/javadoc module as follows:

  • insert the source repository url using the String constant in the Source taglet class
  • add option to replace existing source tags (--replace)
  • omit svn URL keyword by default with an option to add it (--svn)

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Michael Bedward added a comment -
changes committed to trunk (r37268) and 2.7.x branch (r37269)
Show
Michael Bedward added a comment - changes committed to trunk (r37268) and 2.7.x branch (r37269)
Hide
Permalink
Michael Bedward added a comment -
Updated developer guide (coding style page) for new usage of InsertSourceTags
Show
Michael Bedward added a comment - Updated developer guide (coding style page) for new usage of InsertSourceTags
Hide
Permalink
Michael Bedward added a comment -
The updating routine has problems were an existing @source tag has been incorrectly split across lines. Need to add a step to detect such tags and replace them.
Show
Michael Bedward added a comment - The updating routine has problems were an existing @source tag has been incorrectly split across lines. Need to add a step to detect such tags and replace them.
Hide
Permalink
Michael Bedward added a comment -
Added a check to the InsertSourceTag utility for existing @source tags that have been split across lines by auto-formatting.

Added more output to flag when and why files are skipped.

Fixed spurious matching of class names in comment blocks.

Added option to include non-public classes in processing.

Fixed problem where enum classes were being missed.

Added "Source repository" output to the taglet's toString method.
Show
Michael Bedward added a comment - Added a check to the InsertSourceTag utility for existing @source tags that have been split across lines by auto-formatting. Added more output to flag when and why files are skipped. Fixed spurious matching of class names in comment blocks. Added option to include non-public classes in processing. Fixed problem where enum classes were being missed. Added "Source repository" output to the taglet's toString method.
Hide
Permalink
Michael Bedward added a comment -
committed to trunk (r37275) and 2.7.x branch (r37276)
Show
Michael Bedward added a comment - committed to trunk (r37275) and 2.7.x branch (r37276)

People

  • Assignee:
    Michael Bedward
    Reporter:
    Michael Bedward
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: