Options provided by the dbdoclet doclet

dbdoclet -abstract text> Property: docbook.abstract

Specifies the abstract for the generated document. If no abstract is defined, the first sentence of the overview file is used as abstract. If there is no overview file, no abstract is created.

dbdoclet -authoremail text Property: docbook.author.email

Specifies the email address of the author. The options -authorfirstname and -authorsurname must be set, otherwise this option will be ignored.

dbdoclet -authorfirstname text Property: docbook.author.firstname

Specifies the firstname of the author. The option -authorsurname must be set, otherwise this option will be ignored.

dbdoclet -authorsurname text Property: docbook.author.surname

Specifies the surname of the author. The option -authorfirstname must be set, otherwise this option will be ignored.

dbdoclet -booktype book|reference Property: doclet.book.type

Specifies the type of the book. The type "book" contains chapter elements, while the type "reference" contains refentry elements.

dbdoclet -codewidth width Property: docbook.code.width

Specifies the width of program listings. The default is 75.

dbdoclet -copyrightholder text Property: docbook.copyright.holder

Specifies the holder of the copyright.

dbdoclet -copyrightyear text Property: docbook.copyright.year

Specifies the copyright year(s). The option -copyrightholder must be set for this option to become active.

dbdoclet -corporation text Property: docbook.corporation

Specifies the corporation name.

dbdoclet -dotfqn Property: program.dot.qualified-names

Use qualified names in dot diagrams.

dbdoclet -emphasisrole text Property: docbook.emphasis.role

Specifies the role for the emphasis tag. The default is "bold".

dbdoclet -f file Property: doclet.destination.file

Specifies the file name of the resulting document. If the file name contains a path, it is appended to destination directory. The default name for the file name is Reference.xml.

dbdoclet -id numbered | java Property: docbook.id.style

This option controls the generation of reference ids. If set to "numbered", the ids start with a type string followed by a number. The number is generated by a counter. This is the default behaviour. If set to "java" the id's are created in a predictable way. This makes it possible to reference certain elements in the generated docbook source from other parts of the document. The id values start with a type string. The used type strings are PACKAGE-, CLASS-, CONSTRUCTOR-, METHOD- and FIELD-. The next part of the identifier is the full qualified name of the java element, which is referenced. Because of limitations due to the id attribute, certain characters are substituted: "(", ")","[","]","_" and "," are replaced by "-" and " " is replaced by "". I think the best thing to do, is to have a look at the generated SGML code. Perhaps somebody can explain this feature in correct english and sent the result to me.

dbdoclet -imgfmts gif,png,jpg,svg,ps Property: docbook.imagedata.formats

Specifies a comma separated list of the formats, that will be used when creating imagedata tags. The default is "svg".

dbdoclet -imgpath directory Property: doclet.imagepath

The path where images are stored. The default is "figures".

dbdoclet -include file1,file2,file3... Property: docbook.include

This option make it possible to write the introduction of the resulting book in DocBook itself. You can define a comma separated list of files, which are included as entities or via xinclude at the top, directly after the bookinfo tag.

dbdoclet -noexception Property: doclet.noexception

Don't include @exception and @throws tags.

dbdoclet -nofields Property: doclet.nofields

Don't include the fields section.

dbdoclet -noinheritedfrom Property: doclet.noinheritedfrom

Don't include the "Methods inherited from" sections.

dbdoclet -nometa Property: doclet.nometa

Only include @param, @return, @serialField and @throws tags. This option overrides the options -author and -version.

dbdoclet -nomethods Property: doclet.nomethods

Don't include the methods section.

dbdoclet -noparam Property: doclet.noparam

Don't include @param tags.

dbdoclet -noprolog Property: doclet.noprolog

Don't include a XML prolog. The XML file will start directly with the root tag.

dbdoclet -nosee Property: doclet.nosee

Don't include @see tags.

dbdoclet -noserialfield Property: doclet.noserialField

Don't include @serialField tags.

dbdoclet -nostatistics Property: doclet.nostatistics

Set this argument to true, if you don't want to include the statistics appendix.

dbdoclet -nosynopsis Property: doclet.nosynopsis

Don't include synopsis sections.

dbdoclet -notable Property: doclet.notable

Don't generate any DocBook tables. Any HTML tables found are ignored and the contents of the table cells is added as paragraphs in the order they are found.

dbdoclet -noxreflabel Property: doclet.noxreflabel

Don't generate xreflabel attributes.

dbdoclet -part Property: doclet.part

If this flag is set, a part document is generated instead of a book document. You can insert this part as a reference part in a superior document.

dbdoclet -split Property: doclet.split-output

If this flag is set, the output is splitted and the doclet generates a modularized version of the documentation. A single XML file is generated for every class in the modules directory. These files are referenced via xinclude from the main file Reference.xml.

dbdoclet -properties path/properties file

Specifies the path and file name of a dbdoclet properties file.

dbdoclet -tableframe Property: docbook.table.frame

Defines the DocBook table style for the tables generated by dbdoclet. Should be one of all, bottom, none, sides, top, topbot. The default is set to "all".

dbdoclet -useappendix Property: doclet.use-appendix

If this flag is set an appendices are created instead of chapters for sections like "statistics" and "constant field values".