CliOptions class

Options, as seen by the application. Most are mandatory.

Signature

export declare class CliOptions

Constructors

Constructor	Modifiers	Description
(constructor)(commandOptions)		Constructs a new instance of the CliOptions class

Properties

Property	Modifiers	Type	Description
apiBaseUrl		string	Relative to the docs home, like api, without initial/final slashes.
apiFolderPath		string	Relative to the docs folder, like api, no initial/final slashes.
baseUrl		string	Site base URL, like / or /xxx/.
compatibilityRedirectsOutputFolderPath?		string | undefined	(Optional) Relative to the current website/static folder, like reference.
customCssFilePath		string	Relative to the current website folder, default src/css/custom-doxygen.css
debug		boolean	Boolean to control debug verbosity.
docsBaseUrl		string	Relative to the web home, like docs, without initial/final slashes.
docsFolderPath		string	Relative to the current website folder, like docs, no initial/final slashes.
doxygenXmlInputFolderPath		string	Relative to the current website folder, like doxygen/xml, no initial/ final slashes.
id		string	String identifier in case of multiple instances.
imagesFolderPath		string	Relative to static
listPagesAtTop		boolean	Boolean to list the pages at the top of the sidebar.
mainPageTitle		string	The title to be displayed on the main page.
navbarDropdownFilePath		string	Relative to the current website folder.
navbarDropdownLabel		string	Short text to be displayed in the top navigation bar.
originalPagesNote		string	Location of original Doxygen pages 'For comparison, the original Doxygen html pages, styled with the doxygen-awesome-css plugin, continue to be available via the .../doxygen/*.html URLs.'
renderProgramListing		boolean	Boolean to render the program listing in the File pages.
renderProgramListingInline		boolean	Boolean to render the program listing in the member definitions sections.
sidebarCategoryFilePath		string	Relative to the current website folder.
sidebarCategoryLabel		string	Short text to be displayed in the sidebar.
suggestToDoDescriptions		boolean	Boolean to control if the TODO suggestions are shown.
verbose		boolean	Boolean to control verbosity.

Methods

Method	Modifiers	Description
parse()
selectMultiConfiguration(multiConfigurations)