handle documentation page generation More...

#include <DocGenerator.h>

Inheritance diagram for DocGenerator:

Public Slots
void	showClassDoc (const QString &className)
	show documentation page More...

void	showDocPage (const QString &fileName)
	Show documentation page. More...

void	showDocString (const QString &doc)
	Show the given html-formatted string. More...

void	showHelp ()
	show help page in help browser

void	showIntro ()
	show introduction message in help browser

void	updateMetaData ()
	update internal MetaData Object, call when plugins are updated

Public Member Functions
	DocGenerator (QTextBrowser viewer, QObject parent=0)
	Default constructor. More...

Protected Member Functions
QString	_docList (QStringList parList, QString className, QString slotType="") const
	Generate documentation for the given list of parameters. More...

Protected Attributes
QString	_footer
	footer for doc pages

QString	_helpDoc
	current docstring in help browser

QString	_stylesheet
	stylesheet for help doc

QTextBrowser *	_viewer
	pointer to used viewer instance

Private Attributes
MetaData *	_meta
	MetaData of all loaded Plugins.

Detailed Description

Definition at line 35 of file DocGenerator.h.

Constructor & Destructor Documentation

DocGenerator::DocGenerator	(	QTextBrowser *	viewer,
		QObject *	parent = `0`
	)

Parameters

viewer	pointer to help browser display
parent	pointer to parent object

Definition at line 35 of file DocGenerator.cpp.

References _footer, _stylesheet, _viewer, and updateMetaData().

Member Function Documentation

QString DocGenerator::_docList	(	QStringList	parList,
		QString	className,
		QString	slotType = `""`
	)		const

protected

The documentation is arranged in a bullte point list. Each parameter is shown with its type separated by a colon.

Parameters

parList	list of parameters to document
className	class name to generate documentation for
slotType	slot type (if needed), can be "in" or "out"

Returns: html formatted docstring

Definition at line 117 of file DocGenerator.cpp.

References _meta, MetaData::getDefault(), MetaData::getDocString(), MetaData::getType(), MetaData::isMultiSlot(), and MetaData::isOptionalSlot().

void DocGenerator::showClassDoc ( const QString & className )

slot

Parameters

className class name to generate documentation for

Definition at line 184 of file DocGenerator.cpp.

References _docList(), _meta, MetaData::getDocFile(), MetaData::getDocString(), MetaData::getInputs(), MetaData::getOutputs(), MetaData::getParameters(), FileManager::instance(), and showDocString().

void DocGenerator::showDocPage ( const QString & fileName )

slot

The file can use html markup but has to omit the document frame. Only the content between <body></body> has to be passed.

Parameters

fileName name of the html file to display

Definition at line 73 of file DocGenerator.cpp.

References _footer, _helpDoc, _stylesheet, and _viewer.

void DocGenerator::showDocString ( const QString & doc )

slot

This string will be passed to the body of an html document using the global stylesheet.

Parameters

doc	string containing help page (html)

Definition at line 94 of file DocGenerator.cpp.

References _footer, _helpDoc, _stylesheet, and _viewer.

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

src/DocGenerator.h
src/DocGenerator.cpp

Public Slots

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation