FlexDoc/Javadoc - JavadocClassic - Parameters

About JavadocClassic parameters

«Pagination» parameter group

This group of parameters is related specifically to printable documentation (e.g. in RTF format).

It is available only in SingleDoc.tpl main template.

Parameter Name / Type / Description
Generate page columns page.columns : boolean

Specify whether to generate page number columns in summary tables.

Page numbers substitute for hyperlinks in printed documentation and help to navigate it.

Start from new page page.start : boolean

This group of parameters specifies which documentation blocks should start from a new page.

It has effect only when you generate RTF documentation.

Table Of Contents

page.start.toc : boolean

Specify whether the Table Of Contents should start from a new page.

See Also:

Generate | Table Of Contents” parameter

Overview

page.start.overview : boolean

Specify whether the documentation Overview should start from a new page.

See Also:

Generate | Overview” parameter

All Classes Summary

page.start.overview.allClasses : boolean

Specify whether the All Classes Summary should start from a new page.

See Also:

Generate | Overview | All Classes Summary” parameter

Package Overviews

page.start.package : boolean

Specify whether each Package Overview should start from a new page.

See Also:

Generate | Package Overviews” parameter

Class Detail

page.start.class : boolean

Specify whether each class documentation should started from a new page.

See Also:

Generate | Class Detail” parameter