DCodeDocumentation Class Reference

#include <dcodedocumentation.h>

Inheritance diagram for DCodeDocumentation:

Public Member Functions
	DCodeDocumentation (CodeDocument *doc, const QString &text="")
virtual	~DCodeDocumentation ()
virtual int	firstEditableLine ()
virtual QString	getNewEditorLine (int amount)
virtual int	lastEditableLine ()
virtual void	saveToXMI (QDomDocument &doc, QDomElement &root)
QString	toString () const
virtual QString	unformatText (const QString &text, const QString &indent="")
Public Member Functions inherited from CodeComment
	CodeComment (CodeDocument *doc, const QString &comment="")
virtual	~CodeComment ()
virtual void	loadFromXMI (QDomElement &root)
Public Member Functions inherited from TextBlock
	TextBlock (CodeDocument *parent, const QString &text="")
virtual	~TextBlock ()
void	appendText (const QString &text)
bool	canDelete () const
int	getIndentationLevel () const
QString	getIndentationString (int level=0) const
CodeDocument *	getParentDocument () const
QString	getTag () const
QString	getText () const
bool	getWriteOutText () const
virtual void	setAttributesFromObject (TextBlock *obj)
void	setIndentationLevel (int level)
void	setTag (const QString &value)
void	setText (const QString &text)
void	setWriteOutText (bool write)

Additional Inherited Members
Static Public Member Functions inherited from TextBlock
static QString	decodeText (const QString &text, const QString &endLine)
static QString	encodeText (const QString &text, const QString &endLine)
static QString	formatMultiLineText (const QString &work, const QString &linePrefix, const QString &breakStr, bool addBreak=true, bool lastLineHasBreak=true)
static QString	getIndentation ()
static QString	getNewLineEndingChars ()
Protected Member Functions inherited from TextBlock
virtual void	release ()
virtual void	setAttributesFromNode (QDomElement &root)
virtual void	setAttributesOnNode (QDomDocument &doc, QDomElement &blockElement)
void	setCanDelete (bool canDelete)

Detailed Description

A class representing a D documentation comment.

The syntax follows the D Style Guide (

See also

http://www.digitalmars.com/d/dstyle.html). Choice between single line and multiline comments is based on the common policy.

Definition at line 27 of file dcodedocumentation.h.

Constructor & Destructor Documentation

DCodeDocumentation::DCodeDocumentation ( CodeDocument *  doc, const QString &  text = ""  )

explicit

Constructors.

Definition at line 24 of file dcodedocumentation.cpp.

DCodeDocumentation::~DCodeDocumentation ( )

virtual

Empty Destructor.

Definition at line 29 of file dcodedocumentation.cpp.

Member Function Documentation

int DCodeDocumentation::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 code editor (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.

Definition at line 83 of file dcodedocumentation.cpp.

QString DCodeDocumentation::getNewEditorLine ( int  amount )

virtual

A special version here because we want to not only indent the new line, but to add the " * " sequence as well.

Reimplemented from TextBlock.

Definition at line 74 of file dcodedocumentation.cpp.

int DCodeDocumentation::lastEditableLine ( )

virtual

See also

firstEditableLine

Reimplemented from TextBlock.

Definition at line 91 of file dcodedocumentation.cpp.

void DCodeDocumentation::saveToXMI ( QDomDocument &  doc, QDomElement &  root  )

virtual

Save the XMI representation of this object.

Reimplemented from CodeComment.

Definition at line 33 of file dcodedocumentation.cpp.

QString DCodeDocumentation::toString ( ) const

virtual

Creates a documentation block.

The syntax follows the D Style Guide (

See also

http://www.digitalmars.com/d/dstyle.html). Choice between single line and multiline comments is based on the common policy.

Returns

QString Documentation block source code.

Reimplemented from TextBlock.

Definition at line 41 of file dcodedocumentation.cpp.

QString DCodeDocumentation::unformatText ( const QString &  text, const QString &  indent = ""  )

virtual

UnFormat a long text string.

Typically, this means removing the indentaion (linePrefix) and/or newline chars from each line.

Reimplemented from TextBlock.

Definition at line 105 of file dcodedocumentation.cpp.

---

The documentation for this class was generated from the following files:

• dcodedocumentation.h
• dcodedocumentation.cpp