Package eu.bandm.tools.util3

Class ApiDocWarningsFilter

java.lang.Object

eu.bandm.tools.util3.ApiDocWarningsFilter

public class ApiDocWarningsFilter
extends Object

Takes the output protocol of javadoc and filters, counts, and re-arranges the warning messages. Because a larger project as metatools can have 40_000 warnings, the warnings of the most important categories are extracted and presented as a survey.

Storing and presenting is as follows:

  "warning:noMainDescription"\
                              V
  "warning:noComment" ----> methodTextMissing --> methodTextMissingByPackage

  "warning: no @param"  --> detailTextMissing --> detailTextMissingByPackage
  "warning: no @throws" ----^       ^                   ^
  "warning: no @return" --/       /                    /
  "warning: no description for " /                    /
                                                     /
  "warning: use of default constructor"---> defaultConstructor
  

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TOOLS_ROOT

Constructor Summary

Constructors

Constructor	Description
ApiDocWarningsFilter()

Method Summary

Modifier and Type	Method	Description
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Field Details

TOOLS_ROOT

public static final String TOOLS_ROOT

See Also:

• Constant Field Values

Constructor Details

ApiDocWarningsFilter

public ApiDocWarningsFilter()

Method Details

main

public static void main(String[] args)
                 throws IOException

Parameters:

args - [0] = input file [1] = output file.

Throws:

IOException