You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
80 lines
2.6 KiB
80 lines
2.6 KiB
/***************************************************************************
|
|
docbookgenerator.h - description
|
|
-------------------
|
|
begin : THu Jun 22 2006
|
|
copyright : (C) 2006 by Gael de Chalendar (aka Kleag)
|
|
email : kleag@free.fr
|
|
***************************************************************************/
|
|
|
|
/***************************************************************************
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
***************************************************************************/
|
|
|
|
#ifndef DOCBOOKGENERATOR_H
|
|
#define DOCBOOKGENERATOR_H
|
|
|
|
#include <kurl.h>
|
|
#include <tqobject.h>
|
|
|
|
class UMLDoc;
|
|
|
|
namespace TDEIO
|
|
{
|
|
class Job;
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
* @todo allow to specify the destination and ensure that it works with distant
|
|
* ones
|
|
*/
|
|
class DocbookGenerator : public TQObject
|
|
{
|
|
TQ_OBJECT
|
|
|
|
public:
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
DocbookGenerator();
|
|
|
|
/**
|
|
* Empty Destructor
|
|
*/
|
|
virtual ~DocbookGenerator();
|
|
|
|
/**
|
|
* 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
|
|
* @todo better handling of error conditions
|
|
* @return true if saving is successful and false otherwise.
|
|
*/
|
|
bool generateDocbookForProject();
|
|
|
|
/**
|
|
* Exports the current model to docbook in the given directory
|
|
* @param destDir the directory where the docbook file and the figures will
|
|
* be written
|
|
* @todo better handling of error conditions
|
|
* @return true if saving is successful and false otherwise.
|
|
*/
|
|
TDEIO::Job* generateDocbookForProjectInto(const KURL& destDir);
|
|
|
|
};
|
|
|
|
#endif // DOCBOOKGENERATOR_H
|