public class

DocdownOption

extends Object

 java.lang.Object

↳com.parrot.docdown.DocdownOption

Overview

Doclet command line option parser

Summary

Fields
private List<IRefProvider>externalRefProviders

private List<Path>includeCodeDirs

private PathoutputDir

private List<Path>projectDocSrcDirs

private Stringtitle

Constructors
publicDocdownOption()

Methods
private booleanaddLinkProvider(String url, com.sun.javadoc.DocErrorReporter reporter)

private booleanaddLinkProvider(String url, String packageListUrl, com.sun.javadoc.DocErrorReporter reporter)

public Collection<IRefProvider>getExternalRefProviders()

public StringgetHeadTitle()

public Collection<Path>getIncludeDirs()

public PathgetOutputDir()

public Collection<Path>getSrcDirs()

public intoptionLength(String option)

Gets the numer of argument of an option.

public booleanparseOptions(String options[][], com.sun.javadoc.DocErrorReporter reporter)

Parse command line options.

private voidprintUsage()

private booleansetDocSourcePaths(String paths, com.sun.javadoc.DocErrorReporter reporter)

private booleansetIncludeCodePaths(String paths, com.sun.javadoc.DocErrorReporter reporter)

private booleansetOutputDir(String outputDirName, com.sun.javadoc.DocErrorReporter reporter)

private booleansetTitle(String title, com.sun.javadoc.DocErrorReporter reporter)

from Object, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Fields

private String title

private List<Path> projectDocSrcDirs

private List<Path> includeCodeDirs

private Path outputDir

private List<IRefProvider> externalRefProviders

Constructors

public DocdownOption()

Methods

public int optionLength(String option)

Gets the numer of argument of an option.

Parameters:

option: the option to get the number of arguments

Returns:

the number of argument of the option

public boolean parseOptions(String options[][], com.sun.javadoc.DocErrorReporter reporter)

Parse command line options.

Parameters:

options: command line options to parse
reporter: error reporter

Returns:

true if options are valid.

private boolean setTitle(String title, com.sun.javadoc.DocErrorReporter reporter)

private boolean setOutputDir(String outputDirName, com.sun.javadoc.DocErrorReporter reporter)

private boolean setDocSourcePaths(String paths, com.sun.javadoc.DocErrorReporter reporter)

private boolean setIncludeCodePaths(String paths, com.sun.javadoc.DocErrorReporter reporter)

private boolean addLinkProvider(String url, com.sun.javadoc.DocErrorReporter reporter)

private boolean addLinkProvider(String url, String packageListUrl, com.sun.javadoc.DocErrorReporter reporter)

private void printUsage()

public Path getOutputDir()

public Collection<Path> getSrcDirs()

public Collection<Path> getIncludeDirs()

public Collection<IRefProvider> getExternalRefProviders()

public String getHeadTitle()

Generated by Docdown 0.3.0