ObjectDocumentation Class Reference

#include <ObjectDocumentation.h>

Inheritance diagram for ObjectDocumentation:

Public Types
enum	ComponentType { DataStructure, Pointer, Data, EngineComponent }

Public Member Functions
	ObjectDocumentation (QObject *parent=0)
	~ObjectDocumentation ()
void	addMethod (MethodDocumentation *method)
void	addProperty (PropertyDocumentation *property)
QString	apiDocumentAnchor ()
QString	apiDocumentIdentifier ()
ComponentType	componentType () const
QVariantList	description () const
QString	id () const
QList< MethodDocumentation * >	methods () const
QString	objectParent () const
QList< PropertyDocumentation * >	properties () const
void	setComponentType (const QString &compenentTypeName)
void	setDescription (const QStringList &description)
void	setId (const QString &id)
void	setObjectParent (const QString &id)
void	setSyntaxExample (const QString &syntaxExample)
void	setTitle (const QString &title)
QString	syntaxExample () const
QString	title () const

Properties
QVariantList	description
QString	id
QString	syntaxExample
QString	title

Detailed Description

Definition at line 30 of file ObjectDocumentation.h.

Member Enumeration Documentation

enum ObjectDocumentation::ComponentType

Enumerator
DataStructure
Pointer
Data
EngineComponent

Definition at line 39 of file ObjectDocumentation.h.

Constructor & Destructor Documentation

ObjectDocumentation::ObjectDocumentation ( QObject *  parent = 0 )

explicit

Definition at line 23 of file ObjectDocumentation.cpp.

ObjectDocumentation::~ObjectDocumentation

(

)

Definition at line 28 of file ObjectDocumentation.cpp.

Member Function Documentation

void ObjectDocumentation::addMethod

(

MethodDocumentation *

method

)

Definition at line 115 of file ObjectDocumentation.cpp.

void ObjectDocumentation::addProperty

(

PropertyDocumentation *

property

)

Definition at line 105 of file ObjectDocumentation.cpp.

QString ObjectDocumentation::apiDocumentAnchor

(

)

QString ObjectDocumentation::apiDocumentIdentifier

(

)

Definition at line 135 of file ObjectDocumentation.cpp.

ObjectDocumentation::ComponentType ObjectDocumentation::componentType

(

)

const

Definition at line 66 of file ObjectDocumentation.cpp.

QVariantList ObjectDocumentation::description

(

)

const

QString ObjectDocumentation::id

(

)

const

QList< MethodDocumentation * > ObjectDocumentation::methods

(

)

const

Definition at line 120 of file ObjectDocumentation.cpp.

QString ObjectDocumentation::objectParent

(

)

const

Definition at line 130 of file ObjectDocumentation.cpp.

QList< PropertyDocumentation * > ObjectDocumentation::properties

(

)

const

Definition at line 110 of file ObjectDocumentation.cpp.

void ObjectDocumentation::setComponentType

(

const QString &

compenentTypeName

)

Definition at line 42 of file ObjectDocumentation.cpp.

void ObjectDocumentation::setDescription

(

const QStringList &

description

)

Definition at line 81 of file ObjectDocumentation.cpp.

void ObjectDocumentation::setId

(

const QString &

id

)

Definition at line 32 of file ObjectDocumentation.cpp.

void ObjectDocumentation::setObjectParent

(

const QString &

id

)

Definition at line 125 of file ObjectDocumentation.cpp.

void ObjectDocumentation::setSyntaxExample

(

const QString &

syntaxExample

)

Definition at line 95 of file ObjectDocumentation.cpp.

void ObjectDocumentation::setTitle

(

const QString &

title

)

Definition at line 71 of file ObjectDocumentation.cpp.

QString ObjectDocumentation::syntaxExample

(

)

const

QString ObjectDocumentation::title

(

)

const

Property Documentation

QVariantList ObjectDocumentation::description

read

Definition at line 36 of file ObjectDocumentation.h.

QString ObjectDocumentation::id

read

Definition at line 33 of file ObjectDocumentation.h.

QString ObjectDocumentation::syntaxExample

read

Definition at line 35 of file ObjectDocumentation.h.

QString ObjectDocumentation::title

read

Definition at line 34 of file ObjectDocumentation.h.

---

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

• ObjectDocumentation.h
• ObjectDocumentation.cpp