| |
|
| java.lang.Object org.geotools.maven.tools.CommentUpdater
CommentUpdater | public class CommentUpdater implements FileFilter(Code) | | Add a javadoc tag at the end of class comment in a set of source files.
The default implementation add the
@source URL tag. The algorithm
used in this class has limited capabilities and expects comments formatted
in a "classic" fashion:
- Javadoc comments just before the first "
class " keyword found in the source file.
- "slash-star" style comment at the begining of the first comment line.
- "star-slash" style comment at the end of the last comment line.
version: $Id: CommentUpdater.java 20606 2006-07-18 14:31:51Z jgarnett $ author: Martin Desruisseaux |
Constructor Summary | |
public | CommentUpdater() Creates an updater for the default javadoc tag. |
Method Summary | |
public boolean | accept(File pathname) Tests whether or not the specified abstract pathname should be processed. | public static void | main(String[] args) Process all files specified on the command line. | protected boolean | process(File file) Process the specified file.
Parameters: file - The file to process. |
CommentUpdater | public CommentUpdater()(Code) | | Creates an updater for the default javadoc tag.
|
accept | public boolean accept(File pathname)(Code) | | Tests whether or not the specified abstract pathname should be processed.
|
main | public static void main(String[] args) throws IOException(Code) | | Process all files specified on the command line. If the specified files are directories,
all
.java files found in those directories and sub-directories will be processed.
Parameters: args - List of files or directories to process. throws: IOException - if an I/O operation failed. |
process | protected boolean process(File file) throws IOException(Code) | | Process the specified file.
Parameters: file - The file to process. true if the file has been modified. throws: IOException - if an I/O operation failed. |
|
|
|