blob: 775a7383099ab4d17d6db98714859aabf8046107 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
/***************************************************************************
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 <qobject.h>
class UMLDoc;
namespace KIO
{
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 QObject
{
Q_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.
*/
KIO::Job* generateDocbookForProjectInto(const KURL& destDir);
};
#endif // DOCBOOKGENERATOR_H
|
