#include <src/linkifytext.h>

Collaboration diagram for LinkifyTextOptions:

Public Member Functions
const Definition *	scope () const
const FileDef *	fileScope () const
const Definition *	self () const
const ArgumentList *	argumentList () const
bool	autoBreak () const
bool	external () const
bool	keepSpaces () const
int	indentLevel () const
size_t	breakThreshold () const
LinkifyTextOptions &	setScope (const Definition *scope)
LinkifyTextOptions &	setFileScope (const FileDef *fileScope)
LinkifyTextOptions &	setSelf (const Definition *self)
LinkifyTextOptions &	setArgumentList (const ArgumentList *al)
LinkifyTextOptions &	setAutoBreak (bool autoBreak)
LinkifyTextOptions &	setExternal (bool external)
LinkifyTextOptions &	setKeepSpaces (bool keepSpaces)
LinkifyTextOptions &	setIndentLevel (int indentLevel)
LinkifyTextOptions &	setBreakThreshold (size_t breakThreshold)

Private Attributes
const Definition *	m_scope = nullptr
const FileDef *	m_fileScope = nullptr
const Definition *	m_self = nullptr
const ArgumentList *	m_al = nullptr
bool	m_autoBreak = false
bool	m_external = true
bool	m_keepSpaces = false
int	m_indentLevel = 0
size_t	m_breakThreshold = 30

Detailed Description

Definition at line 43 of file linkifytext.h.

Member Function Documentation

◆ argumentList()

const ArgumentList * LinkifyTextOptions::argumentList ( ) const

inline

Definition at line 50 of file linkifytext.h.

50{ return m_al; }

LinkifyTextOptions::m_al

const ArgumentList * m_al

Definition linkifytext.h:90

References m_al.

Referenced by linkifyText().

◆ autoBreak()

bool LinkifyTextOptions::autoBreak ( ) const

inline

Definition at line 51 of file linkifytext.h.

51{ return m_autoBreak; }

LinkifyTextOptions::m_autoBreak

bool m_autoBreak

Definition linkifytext.h:91

References m_autoBreak.

Referenced by linkifyText(), and setAutoBreak().

◆ breakThreshold()

size_t LinkifyTextOptions::breakThreshold ( ) const

inline

Definition at line 55 of file linkifytext.h.

55{ return m_breakThreshold; }

LinkifyTextOptions::m_breakThreshold

size_t m_breakThreshold

Definition linkifytext.h:95

References m_breakThreshold.

Referenced by linkifyText(), and setBreakThreshold().

◆ external()

bool LinkifyTextOptions::external ( ) const

inline

Definition at line 52 of file linkifytext.h.

52{ return m_external; }

LinkifyTextOptions::m_external

bool m_external

Definition linkifytext.h:92

References m_external.

Referenced by linkifyText(), and setExternal().

◆ fileScope()

const FileDef * LinkifyTextOptions::fileScope ( ) const

inline

Definition at line 48 of file linkifytext.h.

48{ return m_fileScope; }

LinkifyTextOptions::m_fileScope

const FileDef * m_fileScope

Definition linkifytext.h:88

References m_fileScope.

Referenced by linkifyText(), and setFileScope().

◆ indentLevel()

int LinkifyTextOptions::indentLevel ( ) const

inline

Definition at line 54 of file linkifytext.h.

54{ return m_indentLevel; }

LinkifyTextOptions::m_indentLevel

int m_indentLevel

Definition linkifytext.h:94

References m_indentLevel.

Referenced by linkifyText(), and setIndentLevel().

◆ keepSpaces()

bool LinkifyTextOptions::keepSpaces ( ) const

inline

Definition at line 53 of file linkifytext.h.

53{ return m_keepSpaces; }

LinkifyTextOptions::m_keepSpaces

bool m_keepSpaces

Definition linkifytext.h:93

References m_keepSpaces.

Referenced by linkifyText(), and setKeepSpaces().

◆ scope()

const Definition * LinkifyTextOptions::scope ( ) const

inline

Definition at line 47 of file linkifytext.h.

47{ return m_scope; }

LinkifyTextOptions::m_scope

const Definition * m_scope

Definition linkifytext.h:87

References m_scope.

Referenced by linkifyText(), and setScope().

◆ self()

const Definition * LinkifyTextOptions::self ( ) const

inline

Definition at line 49 of file linkifytext.h.

49{ return m_self; }

LinkifyTextOptions::m_self

const Definition * m_self

Definition linkifytext.h:89

References m_self.

Referenced by linkifyText(), and setSelf().

◆ setArgumentList()

LinkifyTextOptions & LinkifyTextOptions::setArgumentList ( const ArgumentList * al )

inline

Definition at line 67 of file linkifytext.h.

68 { m_al = al; return *this; }

References m_al.

◆ setAutoBreak()

LinkifyTextOptions & LinkifyTextOptions::setAutoBreak ( bool autoBreak )

inline

Definition at line 70 of file linkifytext.h.

71 { m_autoBreak = autoBreak; return *this; }

LinkifyTextOptions::autoBreak

bool autoBreak() const

Definition linkifytext.h:51

References autoBreak(), and m_autoBreak.

◆ setBreakThreshold()

LinkifyTextOptions & LinkifyTextOptions::setBreakThreshold ( size_t breakThreshold )

inline

Definition at line 82 of file linkifytext.h.

83 { m_breakThreshold = breakThreshold; return *this; }

LinkifyTextOptions::breakThreshold

size_t breakThreshold() const

Definition linkifytext.h:55

References breakThreshold(), and m_breakThreshold.

◆ setExternal()

LinkifyTextOptions & LinkifyTextOptions::setExternal ( bool external )

inline

Definition at line 73 of file linkifytext.h.

74 { m_external = external; return *this; }

LinkifyTextOptions::external

bool external() const

Definition linkifytext.h:52

References external(), and m_external.

◆ setFileScope()

LinkifyTextOptions & LinkifyTextOptions::setFileScope ( const FileDef * fileScope )

inline

Definition at line 61 of file linkifytext.h.

62 { m_fileScope = fileScope; return *this; }

LinkifyTextOptions::fileScope

const FileDef * fileScope() const

Definition linkifytext.h:48

References fileScope(), and m_fileScope.

Referenced by MemberDefImpl::_writeTemplatePrefix(), generateSqlite3ForMember(), generateXMLForClass(), generateXMLForConcept(), generateXMLForMember(), insertMemberFunctionParams(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), MemberDefImpl::writeDocumentation(), writeExceptionListImpl(), MemberDefImpl::writeMemberDocSimple(), and writeTemplateArgumentList().

◆ setIndentLevel()

LinkifyTextOptions & LinkifyTextOptions::setIndentLevel ( int indentLevel )

inline

Definition at line 79 of file linkifytext.h.

80 { m_indentLevel = indentLevel; return *this; }

LinkifyTextOptions::indentLevel

int indentLevel() const

Definition linkifytext.h:54

References indentLevel(), and m_indentLevel.

◆ setKeepSpaces()

LinkifyTextOptions & LinkifyTextOptions::setKeepSpaces ( bool keepSpaces )

inline

Definition at line 76 of file linkifytext.h.

77 { m_keepSpaces = keepSpaces; return *this; }

LinkifyTextOptions::keepSpaces

bool keepSpaces() const

Definition linkifytext.h:53

References keepSpaces(), and m_keepSpaces.

◆ setScope()

LinkifyTextOptions & LinkifyTextOptions::setScope ( const Definition * scope )

inline

Definition at line 58 of file linkifytext.h.

59 { m_scope = scope; return *this; }

LinkifyTextOptions::scope

const Definition * scope() const

Definition linkifytext.h:47

References m_scope, and scope().

Referenced by MemberDefImpl::_writeTemplatePrefix(), generateSqlite3ForMember(), generateXMLForClass(), generateXMLForConcept(), generateXMLForMember(), insertMemberFunctionParams(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), MemberDefImpl::writeDocumentation(), writeExceptionListImpl(), MemberDefImpl::writeMemberDocSimple(), and writeTemplateArgumentList().

◆ setSelf()

LinkifyTextOptions & LinkifyTextOptions::setSelf ( const Definition * self )

inline

Definition at line 64 of file linkifytext.h.

65 { m_self = self; return *this;}

LinkifyTextOptions::self

const Definition * self() const

Definition linkifytext.h:49

References m_self, and self().

Referenced by MemberDefImpl::_writeTemplatePrefix(), generateSqlite3ForMember(), generateXMLForMember(), insertMemberFunctionParams(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), MemberDefImpl::writeDocumentation(), writeExceptionListImpl(), and MemberDefImpl::writeMemberDocSimple().

Member Data Documentation

◆ m_al

const ArgumentList* LinkifyTextOptions::m_al = nullptr

private

Definition at line 90 of file linkifytext.h.

Referenced by argumentList(), and setArgumentList().

◆ m_autoBreak

bool LinkifyTextOptions::m_autoBreak = false

private

Definition at line 91 of file linkifytext.h.

Referenced by autoBreak(), and setAutoBreak().

◆ m_breakThreshold

size_t LinkifyTextOptions::m_breakThreshold = 30

private

Definition at line 95 of file linkifytext.h.

Referenced by breakThreshold(), and setBreakThreshold().

◆ m_external

bool LinkifyTextOptions::m_external = true

private

Definition at line 92 of file linkifytext.h.

Referenced by external(), and setExternal().

◆ m_fileScope

const FileDef* LinkifyTextOptions::m_fileScope = nullptr

private

Definition at line 88 of file linkifytext.h.

Referenced by fileScope(), and setFileScope().

◆ m_indentLevel

int LinkifyTextOptions::m_indentLevel = 0

private

Definition at line 94 of file linkifytext.h.

Referenced by indentLevel(), and setIndentLevel().

◆ m_keepSpaces

bool LinkifyTextOptions::m_keepSpaces = false

private

Definition at line 93 of file linkifytext.h.

Referenced by keepSpaces(), and setKeepSpaces().

◆ m_scope

const Definition* LinkifyTextOptions::m_scope = nullptr

private

Definition at line 87 of file linkifytext.h.

Referenced by scope(), and setScope().

◆ m_self

const Definition* LinkifyTextOptions::m_self = nullptr

private

Definition at line 89 of file linkifytext.h.

Referenced by self(), and setSelf().

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

src/linkifytext.h

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ argumentList()

◆ autoBreak()

◆ breakThreshold()

◆ external()

◆ fileScope()

◆ indentLevel()

◆ keepSpaces()

◆ scope()

◆ self()

◆ setArgumentList()

◆ setAutoBreak()

◆ setBreakThreshold()

◆ setExternal()

◆ setFileScope()

◆ setIndentLevel()

◆ setKeepSpaces()

◆ setScope()

◆ setSelf()

Member Data Documentation

◆ m_al

◆ m_autoBreak

◆ m_breakThreshold

◆ m_external

◆ m_fileScope

◆ m_indentLevel

◆ m_keepSpaces

◆ m_scope

◆ m_self