DocOptions Struct Reference

Helper class to pass options when calling OutputList::generateDoc(). More...

#include <src/docoptions.h>

Collaboration diagram for DocOptions:

Public Member Functions
bool	indexWords () const
bool	isExample () const
DString	exampleName () const
bool	singleLine () const
bool	linkFromIndex () const
bool	markdownSupport () const
bool	autolinkSupport () const
int	sectionLevel () const
DocOptions &	setIndexWords (bool b)
	Indicates whether or not words should be put in the search index.
DocOptions &	setExample (const DString &name)
	Associate this comment block with a given example.
DocOptions &	setSingleLine (bool b)
	Select if this is for a single line, so without starting a new paragraph at the end.
DocOptions &	setLinkFromIndex (bool b)
	Select if the documentation is generated from an index page.
DocOptions &	setMarkdownSupport (bool b)
	Select if the input needs to take markdown markup into account.
DocOptions &	setAutolinkSupport (bool b)
	Select if the input need to perform auto linking of words.
DocOptions &	setSectionLevel (int l)
	Restrict output up to the given section level.

Private Attributes
bool	m_indexWords = false
bool	m_isExample = false
DString	m_exampleName
bool	m_singleLine = false
bool	m_linkFromIndex = false
bool	m_markdownSupport = Config_getBool(MARKDOWN_SUPPORT)
bool	m_autolinkSupport = Config_getBool(AUTOLINK_SUPPORT)
int	m_sectionLevel = -1

Detailed Description

Helper class to pass options when calling OutputList::generateDoc().

Definition at line 23 of file docoptions.h.

Member Function Documentation

autolinkSupport()

bool DocOptions::autolinkSupport ( ) const

inline

Definition at line 33 of file docoptions.h.

{ return m_autolinkSupport; }

References m_autolinkSupport.

Referenced by validatingParseDoc().

exampleName()

DString DocOptions::exampleName ( ) const

inline

Definition at line 29 of file docoptions.h.

{ return m_exampleName;     }

References m_exampleName.

Referenced by validatingParseDoc().

indexWords()

bool DocOptions::indexWords ( ) const

inline

Definition at line 27 of file docoptions.h.

{ return m_indexWords;      }

References m_indexWords.

Referenced by validatingParseDoc().

isExample()

bool DocOptions::isExample ( ) const

inline

Definition at line 28 of file docoptions.h.

{ return m_isExample;       }

References m_isExample.

Referenced by validatingParseDoc().

linkFromIndex()

bool DocOptions::linkFromIndex ( ) const

inline

Definition at line 31 of file docoptions.h.

{ return m_linkFromIndex;   }

References m_linkFromIndex.

Referenced by validatingParseDoc().

markdownSupport()

bool DocOptions::markdownSupport ( ) const

inline

Definition at line 32 of file docoptions.h.

{ return m_markdownSupport; }

References m_markdownSupport.

Referenced by validatingParseDoc().

sectionLevel()

int DocOptions::sectionLevel ( ) const

inline

Definition at line 34 of file docoptions.h.

{ return m_sectionLevel;    }

References m_sectionLevel.

Referenced by OutputList::generateDoc().

setAutolinkSupport()

DocOptions & DocOptions::setAutolinkSupport ( bool b )

inline

Select if the input need to perform auto linking of words.

Definition at line 61 of file docoptions.h.

    { m_autolinkSupport=b; return *this; }

References m_autolinkSupport.

setExample()

DocOptions & DocOptions::setExample ( const DString & name )

inline

Associate this comment block with a given example.

Definition at line 43 of file docoptions.h.

    { m_isExample=!name.empty(); m_exampleName = name; return *this; }

References DString::empty(), m_exampleName, and m_isExample.

setIndexWords()

DocOptions & DocOptions::setIndexWords ( bool b )

inline

Indicates whether or not words should be put in the search index.

Definition at line 39 of file docoptions.h.

    { m_indexWords=b; return *this; }

References m_indexWords.

setLinkFromIndex()

DocOptions & DocOptions::setLinkFromIndex ( bool b )

inline

Select if the documentation is generated from an index page.

In this case context is not used to determine the relative path when making a link.

Definition at line 53 of file docoptions.h.

    { m_linkFromIndex=b; return *this; }

References m_linkFromIndex.

setMarkdownSupport()

DocOptions & DocOptions::setMarkdownSupport ( bool b )

inline

Select if the input needs to take markdown markup into account.

Definition at line 57 of file docoptions.h.

    { m_markdownSupport=b; return *this; }

References m_markdownSupport.

setSectionLevel()

DocOptions & DocOptions::setSectionLevel ( int l )

inline

Restrict output up to the given section level.

Definition at line 65 of file docoptions.h.

    { m_sectionLevel=l; return *this; }

References m_sectionLevel.

setSingleLine()

DocOptions & DocOptions::setSingleLine ( bool b )

inline

Select if this is for a single line, so without starting a new paragraph at the end.

Definition at line 47 of file docoptions.h.

    { m_singleLine=b; return *this; }

References m_singleLine.

singleLine()

bool DocOptions::singleLine ( ) const

inline

Definition at line 30 of file docoptions.h.

{ return m_singleLine;      }

References m_singleLine.

Referenced by validatingParseDoc().

Member Data Documentation

m_autolinkSupport

bool DocOptions::m_autolinkSupport = Config_getBool(AUTOLINK_SUPPORT)

private

Definition at line 76 of file docoptions.h.

Referenced by autolinkSupport(), and setAutolinkSupport().

m_exampleName

DString DocOptions::m_exampleName

private

Definition at line 72 of file docoptions.h.

Referenced by exampleName(), and setExample().

m_indexWords

bool DocOptions::m_indexWords = false

private

Definition at line 70 of file docoptions.h.

Referenced by indexWords(), and setIndexWords().

m_isExample

bool DocOptions::m_isExample = false

private

Definition at line 71 of file docoptions.h.

Referenced by isExample(), and setExample().

m_linkFromIndex

bool DocOptions::m_linkFromIndex = false

private

Definition at line 74 of file docoptions.h.

Referenced by linkFromIndex(), and setLinkFromIndex().

m_markdownSupport

bool DocOptions::m_markdownSupport = Config_getBool(MARKDOWN_SUPPORT)

private

Definition at line 75 of file docoptions.h.

Referenced by markdownSupport(), and setMarkdownSupport().

m_sectionLevel

int DocOptions::m_sectionLevel = -1

private

Definition at line 77 of file docoptions.h.

Referenced by sectionLevel(), and setSectionLevel().

m_singleLine

bool DocOptions::m_singleLine = false

private

Definition at line 73 of file docoptions.h.

Referenced by setSingleLine(), and singleLine().

---

The documentation for this struct was generated from the following file:

• src/docoptions.h