#include <cppcodedocumentation.h>

Inheritance diagram for CPPCodeDocumentation:

Collaboration diagram for CPPCodeDocumentation:

Public Member Functions
	CPPCodeDocumentation (CodeDocument *doc, const QString &text=QString())

virtual	~CPPCodeDocumentation ()

virtual void	saveToXMI (QXmlStreamWriter &writer)

QString	toString () const

virtual QString	unformatText (const QString &text, const QString &indent=QString())

virtual QString	getNewEditorLine (int amount)

virtual int	firstEditableLine ()

virtual int	lastEditableLine ()

Public Member Functions inherited from CodeComment
	CodeComment (CodeDocument *doc, const QString &comment=QString())

virtual	~CodeComment ()

virtual void	loadFromXMI (QDomElement &root)

Public Member Functions inherited from TextBlock
	TextBlock (CodeDocument *parent, const QString &text=QString())

virtual	~TextBlock ()

void	setText (const QString &text)

QString	getText () const

void	appendText (const QString &text)

void	setTag (const QString &value)

QString	getTag () const

CodeDocument *	getParentDocument () const

void	setWriteOutText (bool write)

bool	getWriteOutText () const

void	setIndentationLevel (int level)

int	getIndentationLevel () const

QString	getIndentationString (int level=0) const

bool	canDelete () const

virtual void	setAttributesFromObject (TextBlock *obj)

Additional Inherited Members
Static Public Member Functions inherited from TextBlock
static QString	getIndentation ()

static QString	getNewLineEndingChars ()

static QString	formatMultiLineText (const QString &work, const QString &linePrefix, const QString &breakStr, bool addBreak=true, bool lastLineHasBreak=true)

static QString	encodeText (const QString &text, const QString &endLine)

static QString	decodeText (const QString &text, const QString &endLine)

Protected Member Functions inherited from TextBlock
void	setCanDelete (bool canDelete)

virtual void	release ()

virtual void	setAttributesOnNode (QXmlStreamWriter &writer)

virtual void	setAttributesFromNode (QDomElement &root)

Detailed Description

class CPPCodeDocumentation A CPP code comment. There is only a single styles of comments: these are simply started with double slash sequence and no terminating characters

Constructor & Destructor Documentation

◆ CPPCodeDocumentation()

CPPCodeDocumentation::CPPCodeDocumentation	(	CodeDocument *	doc,
		const QString &	text = `QString()`
	)

explicit

Constructors

◆ ~CPPCodeDocumentation()

CPPCodeDocumentation::~CPPCodeDocumentation ( )

virtual

Empty Destructor

Member Function Documentation

◆ firstEditableLine()

int CPPCodeDocumentation::firstEditableLine ( )

virtual

Ush. These are terrifically bad and must one day go away. Both methods indicate the range of lines in this textblock which may be edited by the codeeditor (assuming that any are actually editable). The default case is no lines are editable. The line numbering starts with '0' and a '-1' means no line qualifies.

Reimplemented from TextBlock.