|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectDTDDoc.DTDCommenter
public class DTDCommenter
Main class to the DTDDoc program, everything happen here.
Field Summary | |
---|---|
static String |
ATTR_COMMENT_TAG
Tag starting an attribute comment (@attr attributeName comment) |
static char |
BEGIN_TAG
Character used to begin a tag. |
static char |
CODE_SEPARATOR
Character used to mark the beginning and the end of a part of a code fragment. |
static char |
CODE_SEPARATOR_DEPRECATED
Character used to mark the beginning and the end of a part of code fragment. |
static String |
COMMENT_TAG
Tag starting a comment (@comment) |
static String |
DOCTYPE_TAG
Tag starting a DTD doctype defintion (@doctype) |
static String |
EXAMPLE_TAG
Tag starting an "example" comment (@example) |
static String |
FIXME_TAG
Tag starting a "fix me" comment (@fixme) |
static String |
HIDDEN_TAG
Tag starting a "hidden" comment (@hidden) |
static String |
ROOT_TAG
Tag starting a root element defintion (@root) |
static String |
TITLE_TAG
Tag starting a DTD title defintion (@title) |
static String |
VERSION
Version of DTDDoc running |
Constructor Summary | |
---|---|
DTDCommenter()
Deprecated. maintained for binary backward compatibility: uses SystemLogger as default logging system. |
|
DTDCommenter(Logger log)
|
Method Summary | |
---|---|
char |
cardinalToChar(com.wutka.dtd.DTDCardinal cardinal)
|
void |
commentDTDs(HashSet scan,
File sourceDir,
File destDir,
boolean showHiddenTags,
boolean showFixmeTags,
String docTitle,
File styleSheet)
Deprecated. signature maintained for binary backward compatibility with versions <= 0.0.11, but equivalent to the other more generic commentDTDs() method |
void |
commentDTDs(Set scan,
File sourceDir,
File destDir,
boolean showHiddenTags,
boolean showFixmeTags,
boolean getAroundNetBeanComments,
String docTitle,
File styleSheet)
This is the main method. |
String |
getDTDBaseURI(ExtendedDTD dtd)
|
String |
getExternalHREF(ExtendedDTD dtd,
com.wutka.dtd.DTDElement element,
String text)
Builds a HTML external reference to an element from the documentation of a DTD ( filename#element_id ). |
String |
getExternalHREF(ExtendedDTD dtd,
String elementName,
String text)
|
String |
getInternalHREF(ExtendedDTD dtd,
com.wutka.dtd.DTDElement element)
Builds a HTML internal reference to an element inside the documentation of a DTD ( #element_id ). |
void |
makeTOC(Set dtds,
String docTitle)
This function will create a table of content for the parsed DTDs documentation, and copy necessary images ( img sub-directory) and
JavaScript library. |
URI |
newURITo(ExtendedDTD dtd)
|
URI |
newURITo(ExtendedDTD dtd,
com.wutka.dtd.DTDAttlist list,
com.wutka.dtd.DTDAttribute attribute)
|
URI |
newURITo(ExtendedDTD dtd,
com.wutka.dtd.DTDElement element)
|
URI |
newURITo(ExtendedDTD dtd,
com.wutka.dtd.DTDElement element,
com.wutka.dtd.DTDAttribute attribute)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String VERSION
public static final char BEGIN_TAG
public static final String COMMENT_TAG
public static final String ATTR_COMMENT_TAG
public static final String FIXME_TAG
public static final String EXAMPLE_TAG
public static final String HIDDEN_TAG
public static final String ROOT_TAG
public static final String TITLE_TAG
public static final String DOCTYPE_TAG
public static final char CODE_SEPARATOR_DEPRECATED
public static final char CODE_SEPARATOR
Constructor Detail |
---|
public DTDCommenter()
public DTDCommenter(Logger log)
Method Detail |
---|
public String getInternalHREF(ExtendedDTD dtd, com.wutka.dtd.DTDElement element)
#element_id
).
dtd
- the target DTD (current, since it is an internal reference).element
- The element to reference.
<a href='#element_id'>element name</a>
public String getExternalHREF(ExtendedDTD dtd, com.wutka.dtd.DTDElement element, String text) throws IOException
filename#element_id
).
dtd
- the target DTD.element
- The element to reference.text
- text that will appear in the reference.
<a href='dtd_reference#element_id'>text</a>
- Throws:
IOException
public String getExternalHREF(ExtendedDTD dtd, String elementName, String text) throws IOException
IOException
public String getDTDBaseURI(ExtendedDTD dtd)
public URI newURITo(ExtendedDTD dtd)
public URI newURITo(ExtendedDTD dtd, com.wutka.dtd.DTDElement element)
public URI newURITo(ExtendedDTD dtd, com.wutka.dtd.DTDAttlist list, com.wutka.dtd.DTDAttribute attribute)
public URI newURITo(ExtendedDTD dtd, com.wutka.dtd.DTDElement element, com.wutka.dtd.DTDAttribute attribute)
public char cardinalToChar(com.wutka.dtd.DTDCardinal cardinal)
public void makeTOC(Set dtds, String docTitle) throws IOException
img
sub-directory) and
JavaScript library.
The TOC will be created in a separate HTML file (toc.html
) so that it
can be used in a frame-structured page.
docTitle
- the title to put at the top of the table.dtds
- the DTD's to make the table of content for.
IOException
public void commentDTDs(HashSet scan, File sourceDir, File destDir, boolean showHiddenTags, boolean showFixmeTags, String docTitle, File styleSheet) throws IOException, Exception
IOException
Exception
public void commentDTDs(Set scan, File sourceDir, File destDir, boolean showHiddenTags, boolean showFixmeTags, boolean getAroundNetBeanComments, String docTitle, File styleSheet) throws IOException
scan
- the DTD files to analyzesourceDir
- the base directory for relative path computationsdestDir
- the destination directory to store the generated documentationshowHiddenTags
- tells if the content of the @hidden
tags must be part of the documentationshowFixmeTags
- tells if the content of the @fixme
tags must be part of the documentationgetAroundNetBeanComments
- in case you have comments that start with three hyphens, this option will
tell DTDDoc to interpret them as regular double hyphens. This was introduced to support NetBeans comments.docTitle
- name of the documentation: it will appear at the top of the index.styleSheet
- the stylesheet to use to render the documentation: it will be copied into the documentation.
If null
, a default stylesheet is used.
IOException
- in case of an error while reading the DTDs or writing the documentation
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |