de.lmu.ifi.dbs.elki.application.internal
Class DocumentParameters
java.lang.Object
de.lmu.ifi.dbs.elki.application.internal.DocumentParameters
public class DocumentParameters
- extends Object
Class to generate HTML parameter descriptions for all classes implementing
the Parameterizable
interface. Used in documentation generation only.
- Author:
- Erich Schubert
Method Summary |
private static void |
appendClassLink(Document htmldoc,
Option<?> opt,
Element p)
|
private static void |
appendClassRestriction(Document htmldoc,
ClassParameter<?> opt,
Element elemdd)
|
private static void |
appendDefaultValueIfSet(Document htmldoc,
Parameter<?,?> par,
Element optdd)
|
private static void |
appendKnownImplementationsIfNonempty(Document htmldoc,
ClassParameter<?> opt,
Element elemdd)
|
private static void |
appendNoClassRestriction(Document htmldoc,
Element elemdd)
|
private static void |
appendNoDefaultValue(Document htmldoc,
Element optdd)
|
private static void |
buildParameterIndex(HashMapList<Class<?>,Option<?>> byclass,
HashMapList<OptionID,Pair<Option<?>,Class<?>>> byopt)
|
private static String |
linkForClassName(String name)
|
static void |
main(String[] args)
|
private static Document |
makeByclassOverview(HashMapList<Class<?>,Option<?>> byclass)
|
private static Document |
makeByoptOverview(HashMapList<OptionID,Pair<Option<?>,Class<?>>> byopt)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
HEADER_PARAMETER_FOR
private static final String HEADER_PARAMETER_FOR
- See Also:
- Constant Field Values
HEADER_DEFAULT_VALUE
private static final String HEADER_DEFAULT_VALUE
- See Also:
- Constant Field Values
NO_DEFAULT_VALUE
private static final String NO_DEFAULT_VALUE
- See Also:
- Constant Field Values
HEADER_CLASS_RESTRICTION
private static final String HEADER_CLASS_RESTRICTION
- See Also:
- Constant Field Values
HEADER_CLASS_RESTRICTION_IMPLEMENTING
private static final String HEADER_CLASS_RESTRICTION_IMPLEMENTING
- See Also:
- Constant Field Values
HEADER_CLASS_RESTRICTION_EXTENDING
private static final String HEADER_CLASS_RESTRICTION_EXTENDING
- See Also:
- Constant Field Values
NO_CLASS_RESTRICTION
private static final String NO_CLASS_RESTRICTION
- See Also:
- Constant Field Values
CSSFILE
private static final String CSSFILE
- See Also:
- Constant Field Values
MODIFICATION_WARNING
private static final String MODIFICATION_WARNING
- See Also:
- Constant Field Values
HEADER_KNOWN_IMPLEMENTATIONS
private static final String HEADER_KNOWN_IMPLEMENTATIONS
- See Also:
- Constant Field Values
DocumentParameters
public DocumentParameters()
main
public static void main(String[] args)
- Parameters:
args
-
buildParameterIndex
private static void buildParameterIndex(HashMapList<Class<?>,Option<?>> byclass,
HashMapList<OptionID,Pair<Option<?>,Class<?>>> byopt)
makeByclassOverview
private static Document makeByclassOverview(HashMapList<Class<?>,Option<?>> byclass)
makeByoptOverview
private static Document makeByoptOverview(HashMapList<OptionID,Pair<Option<?>,Class<?>>> byopt)
appendClassLink
private static void appendClassLink(Document htmldoc,
Option<?> opt,
Element p)
appendClassRestriction
private static void appendClassRestriction(Document htmldoc,
ClassParameter<?> opt,
Element elemdd)
appendNoClassRestriction
private static void appendNoClassRestriction(Document htmldoc,
Element elemdd)
appendKnownImplementationsIfNonempty
private static void appendKnownImplementationsIfNonempty(Document htmldoc,
ClassParameter<?> opt,
Element elemdd)
appendDefaultValueIfSet
private static void appendDefaultValueIfSet(Document htmldoc,
Parameter<?,?> par,
Element optdd)
appendNoDefaultValue
private static void appendNoDefaultValue(Document htmldoc,
Element optdd)
linkForClassName
private static String linkForClassName(String name)