umbrello/umbrello
#include <docbookgenerator.h>
Signals | |
void | finished (bool status) |
Public Member Functions | |
DocbookGenerator () | |
virtual | ~DocbookGenerator () |
bool | generateDocbookForProject () |
void | generateDocbookForProjectInto (const KUrl &destDir) |
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.
- 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
Definition at line 31 of file docbookgenerator.h.
Constructor & Destructor Documentation
DocbookGenerator::DocbookGenerator | ( | ) |
Constructor.
Definition at line 35 of file docbookgenerator.cpp.
|
virtual |
Destructor.
Definition at line 46 of file docbookgenerator.cpp.
Member Function Documentation
|
signal |
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.
Definition at line 59 of file docbookgenerator.cpp.
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.
Definition at line 77 of file docbookgenerator.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:06:02 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.