MethodDocumentation Class Reference

#include <MethodDocumentation.h>

Inheritance diagram for MethodDocumentation:

Public Member Functions
	MethodDocumentation (QObject *parent=0)
void	addParameter (const QString &name, const QString &type, const QString &info, const QString &typeLink)
QString	apiDocumentAnchor ()
QVariantList	description () const
QString	name () const
QList< ParameterDocumentation * >	parameters () const
QVariant	parametersVar () const
QString	returnType () const
QString	returnTypeLink () const
void	setDescription (const QStringList &description)
void	setName (const QString &name)
void	setReturnType (const QString &type)
void	setReturnTypeLink (const QString &link)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Properties
QVariantList	description
QString	documentAnchor
QString	name
QVariant	parameters
QString	returnType
QString	returnTypeLink
Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Detailed Description

Definition at line 29 of file MethodDocumentation.h.

Constructor & Destructor Documentation

MethodDocumentation::MethodDocumentation ( QObject *  parent = 0 )

explicit

Definition at line 22 of file MethodDocumentation.cpp.

Member Function Documentation

void MethodDocumentation::addParameter	(	const QString &	name,
		const QString &	type,
		const QString &	info,
		const QString &	typeLink = QString()
	)

Definition at line 62 of file MethodDocumentation.cpp.

QString MethodDocumentation::apiDocumentAnchor

(

)

Definition at line 82 of file MethodDocumentation.cpp.

QVariantList MethodDocumentation::description

(

)

const

QString MethodDocumentation::name

(

)

const

QList<ParameterDocumentation*> MethodDocumentation::parameters

(

)

const

QVariant MethodDocumentation::parametersVar

(

)

const

Definition at line 72 of file MethodDocumentation.cpp.

QString MethodDocumentation::returnType

(

)

const

QString MethodDocumentation::returnTypeLink

(

)

const

void MethodDocumentation::setDescription

(

const QStringList &

description

)

Definition at line 38 of file MethodDocumentation.cpp.

void MethodDocumentation::setName

(

const QString &

name

)

Definition at line 28 of file MethodDocumentation.cpp.

void MethodDocumentation::setReturnType

(

const QString &

type

)

Definition at line 52 of file MethodDocumentation.cpp.

void MethodDocumentation::setReturnTypeLink

(

const QString &

link

)

Definition at line 87 of file MethodDocumentation.cpp.

Property Documentation

QVariantList MethodDocumentation::description

read

Definition at line 33 of file MethodDocumentation.h.

QString MethodDocumentation::documentAnchor

read

Definition at line 37 of file MethodDocumentation.h.

QString MethodDocumentation::name

read

Definition at line 32 of file MethodDocumentation.h.

QList< ParameterDocumentation * > MethodDocumentation::parameters

read

Definition at line 34 of file MethodDocumentation.h.

QString MethodDocumentation::returnType

read

Definition at line 35 of file MethodDocumentation.h.

QString MethodDocumentation::returnTypeLink

read

Definition at line 36 of file MethodDocumentation.h.

---

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

• MethodDocumentation.h
• MethodDocumentation.cpp