umbrello API Documentation

DocbookGenerator Class Reference

class DocbookGenerator is a documentation generator for UML documents. More...

#include <docbookgenerator.h>

List of all members.

Public Member Functions

 DocbookGenerator ()
 Constructor.
virtual ~DocbookGenerator ()
 Empty Destructor.
bool generateDocbookForProject ()
 Exports the current model to docbook in a directory named as the model with the .xmi suffix removed.
KIO::Job * generateDocbookForProjectInto (const KURL &destDir)
 Exports the current model to docbook in the given directory.


Detailed Description

class DocbookGenerator is a documentation generator for UML documents.

It uses libxslt to convert the XMI generated by UMLDoc::saveToXMI through the XSLT file stored in resources.

Definition at line 41 of file docbookgenerator.h.


Constructor & Destructor Documentation

DocbookGenerator::DocbookGenerator  ) 
 

Constructor.

Definition at line 44 of file docbookgenerator.cpp.

DocbookGenerator::~DocbookGenerator  )  [virtual]
 

Empty Destructor.

Definition at line 48 of file docbookgenerator.cpp.


Member Function Documentation

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

Returns:
true if saving is successful and false otherwise.

Definition at line 51 of file docbookgenerator.cpp.

References generateDocbookForProjectInto(), UMLApp::getDocument(), and UMLDoc::URL().

KIO::Job * 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
Returns:
true if saving is successful and false otherwise.

Definition at line 64 of file docbookgenerator.cpp.

References UMLApp::getDocument(), UMLDoc::saveToXMI(), UMLDoc::setName(), UMLDoc::URL(), and UMLDoc::writeToStatusBar().

Referenced by generateDocbookForProject().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for umbrello Version 3.1.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Jun 26 08:08:04 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003