com.dpslink.base.tool

Class ConvertJavadoc

java.lang.Object

com.dpslink.base.tool.ConvertJavadoc

All Implemented Interfaces:

java.io.Serializable

public class ConvertJavadoc
extends java.lang.Object
implements java.io.Serializable

Converts old style javadoc comments to the new style.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	ivUpdate A flag indicating the current mode is UPDATE.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
ConvertJavadoc(java.lang.String path, java.lang.String mode) Constructs a new javadoc conversion class.

Method Summary

Modifier and Type	Method and Description
private void	convertFile(java.io.File file) Converts the given file's javadoc.
static void	main(java.lang.String[] args) The main entry point for when the class is started from a command line.
private void	recurseFolder(java.io.File folder) Recurses the files and folders in the given folder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

ivUpdate

private boolean ivUpdate

A flag indicating the current mode is UPDATE.

Constructor Detail

ConvertJavadoc

public ConvertJavadoc(java.lang.String path,
                      java.lang.String mode)

Constructs a new javadoc conversion class.

Parameters:

path - (String) The full path to the file or folder to process.

mode - (String) The mode to process. Must be LIST or UPDATE.

Method Detail

main

public static void main(java.lang.String[] args)

The main entry point for when the class is started from a command line.

Parameters:

args - (String[]) A string array of startup parameters.

recurseFolder

private void recurseFolder(java.io.File folder)

Recurses the files and folders in the given folder.

Parameters:

folder - (File) The folder to recurse.

convertFile

private void convertFile(java.io.File file)

Converts the given file's javadoc.

Parameters:

file - (File) The file to convert.