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)

Properties
QVariantList	description
QString	documentAnchor
QString	name
QVariant	parameters
QString	returnType
QString	returnTypeLink

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