DocbookGenerator Class Reference

#include <docbookgenerator.h>

Inheritance diagram for DocbookGenerator:

Collaboration diagram for DocbookGenerator:

Signals
void	finished (bool status)

Public Member Functions
	DocbookGenerator ()
virtual	~DocbookGenerator ()
bool	generateDocbookForProject ()
void	generateDocbookForProjectInto (const KUrl &destDir)

Static Public Member Functions
static QString	customXslFile ()

Private Slots
void	slotDocbookGenerationFinished (const QString &)
void	threadFinished ()

Private Attributes
DocbookGeneratorJob *	docbookGeneratorJob
bool	m_pStatus
bool	m_pThreadFinished
KUrl	m_destDir
UMLDoc *	umlDoc

Detailed Description

class DocbookGenerator is a documentation generator for UML documents. It uses libxslt to convert the XMI generated by UMLDoc::saveToXMI1 through the XSLT file stored in resources.

Todo:

Add configure checks for libxml2 and libxslt and use conditional compilation of this library and its callers

allow to specify the destination and ensure that it works with distant ones

Constructor & Destructor Documentation

DocbookGenerator()

DocbookGenerator::DocbookGenerator

(

)

Constructor.

Here is the call graph for this function:

~DocbookGenerator()

DocbookGenerator::~DocbookGenerator ( )

virtual

Destructor.

Member Function Documentation

customXslFile()

QString DocbookGenerator::customXslFile ( )

static

return custom xsl file for generating docbook

Returns

filename with path

Here is the call graph for this function:

finished

void DocbookGenerator::finished ( bool  status )

signal

generateDocbookForProject()

bool DocbookGenerator::generateDocbookForProject

(

)

Exports the current model to docbook in a directory named as the model with the .xmi suffix removed. The docbook file will have the same name with the .docbook suffix. Figures will be named as the corresponding diagrams in the GUI

Todo:

change file naming to avoid paths with spaces or non-ASCII chars

better handling of error conditions

Returns

true if saving is successful and false otherwise.

Here is the call graph for this function:

generateDocbookForProjectInto()

void DocbookGenerator::generateDocbookForProjectInto

(

const KUrl &

destDir

)

Exports the current model to docbook in the given directory

Parameters

destDir

the directory where the docbook file and the figures will be written

Todo:

better handling of error conditions

Returns

true if saving is successful and false otherwise.

Here is the call graph for this function:

slotDocbookGenerationFinished

void DocbookGenerator::slotDocbookGenerationFinished ( const QString &  tmpFileName )

privateslot

Here is the call graph for this function:

threadFinished

void DocbookGenerator::threadFinished ( )

privateslot

Member Data Documentation

docbookGeneratorJob

DocbookGeneratorJob* DocbookGenerator::docbookGeneratorJob

private

m_destDir

KUrl DocbookGenerator::m_destDir

private

m_pStatus

bool DocbookGenerator::m_pStatus

private

m_pThreadFinished

bool DocbookGenerator::m_pThreadFinished

private

umlDoc

UMLDoc* DocbookGenerator::umlDoc

private

---

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

• umbrello/docgenerators/docbookgenerator.h
• build/umbrello/libumbrello_autogen/4AHWLTORBR/moc_docbookgenerator.cpp
• umbrello/docgenerators/docbookgenerator.cpp