Package uk.ac.starlink.topcat.doc
Class TopcatXmlDoclet
java.lang.Object
FullXmlDoclet
uk.ac.starlink.topcat.doc.TopcatXmlDoclet
public class TopcatXmlDoclet
extends FullXmlDoclet
Doclet which documents public static members of clases in XML
for insertion into the TOPCAT user document.
Optional doclet flags beyond the superclass ones are:
- -act
- Write output only for 'activation' classes - as reported by
TopcatJELUtils.getActivationStaticClasses()
. - -gen
- Write output only for 'general' classes - as reported by
uk.ac.starlink.topcat.TopcatJELUtils.getStaticClasses
.
- Since:
- 6 Sep 2004
- Author:
- Mark Taylor (Starlink)
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic int
optionLength
(String option) Define permitted command-line flags.static boolean
start
(RootDoc root) Begin processing document.protected boolean
useClass
(ClassDoc clazz)
-
Constructor Details
-
TopcatXmlDoclet
Constructor.- Parameters:
root
- root document- Throws:
IOException
-
-
Method Details
-
start
Begin processing document. This method is part of the Doclet public interface.- Throws:
IOException
-
optionLength
Define permitted command-line flags. This method is part of the Doclet public interface. -
useClass
protected boolean useClass(ClassDoc clazz)
-