ApiDocManager Class Reference

#include <ApiDocManager.h>

Inheritance diagram for ApiDocManager:

Signals
void	objectApiAboutToBeAdded (ObjectDocumentation *, int)
void	objectApiAboutToBeRemoved (int, int)
void	objectApiAdded ()
void	objectApiRemoved ()

Public Member Functions
	ApiDocManager (QObject *parent=0)
QString	apiOverviewDocument () const
void	loadLocalData ()
bool	loadObjectApi (const KUrl &path)
ObjectDocumentation *	objectApi (int index) const
QString	objectApiDocument (const QString &identifier)
QList< ObjectDocumentation * >	objectApiList () const

Detailed Description

Load and provide api documentation objects.

Definition at line 37 of file ApiDocManager.h.

Constructor & Destructor Documentation

ApiDocManager::ApiDocManager ( QObject *  parent = 0 )

explicit

Definition at line 40 of file ApiDocManager.cpp.

Member Function Documentation

QString ApiDocManager::apiOverviewDocument

(

)

const

Generates HTML document with the an overview over all available API objects.

Returns

HTML content

Definition at line 265 of file ApiDocManager.cpp.

void ApiDocManager::loadLocalData

(

)

This method loads all api documentation files.

Definition at line 45 of file ApiDocManager.cpp.

bool ApiDocManager::loadObjectApi

(

const KUrl &

path

)

Load documenation object specification from locally stored XML file.

Parameters

path	is the local XML file containing the object API specification

Returns

true if loaded successfully, otherwise false

Definition at line 155 of file ApiDocManager.cpp.

ObjectDocumentation * ApiDocManager::objectApi

(

int

index

)

const

Definition at line 58 of file ApiDocManager.cpp.

void ApiDocManager::objectApiAboutToBeAdded ( ObjectDocumentation *  , int    )

signal

void ApiDocManager::objectApiAboutToBeRemoved ( int  , int    )

signal

void ApiDocManager::objectApiAdded ( )

signal

QString ApiDocManager::objectApiDocument

(

const QString &

identifier

)

Generates HTML document with the API documentation for the specified object.

The generated object is cached such that only the first call to this method is expensive, later calls only return the cached page;

Parameters

identifier

is the identifier of an ObjectDocumentation object

Returns

HTML content

Definition at line 64 of file ApiDocManager.cpp.

QList< ObjectDocumentation * > ApiDocManager::objectApiList

(

)

const

Returns

list of all loaded language specifications

Definition at line 53 of file ApiDocManager.cpp.

void ApiDocManager::objectApiRemoved ( )

signal

---

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

• ApiDocManager.h
• ApiDocManager.cpp