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
|
/******************************************************************************
*
*
*
* Copyright (C) 1997-2015 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
* documentation under the terms of the GNU General Public License is hereby
* granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
* Documents produced by Doxygen are derivative works derived from the
* input used in their production; they are not affected by this license.
*
*/
/*
* eclipsehelp.h
*
* Created on: 7.11.2009
* Author: ondrej
*/
#ifndef ECLIPSEHELP_H
#define ECLIPSEHELP_H
#include <memory>
#include "qcstring.h"
/* -- forward declarations */
class Definition;
class MemberDef;
/** Generator for Eclipse help files.
*
* This class generates the Eclipse specific help files.
* These files can be used to generate a help plugin readable
* by the Eclipse IDE.
*/
class EclipseHelp
{
public:
EclipseHelp();
virtual ~EclipseHelp();
EclipseHelp(EclipseHelp &&);
/* -- index interface */
virtual void initialize();
virtual void finalize();
virtual void incContentsDepth();
virtual void decContentsDepth();
virtual void addContentsItem(bool isDir, const QCString &name, const QCString &ref,
const QCString &file, const QCString &anchor,bool separateIndex,bool addToNavIndex,
const Definition *def);
virtual void addIndexItem(const Definition *context,const MemberDef *md,
const QCString §ionAnchor,const QCString &title);
virtual void addIndexFile(const QCString &name);
virtual void addImageFile(const QCString &name);
virtual void addStyleSheetFile(const QCString &name);
private:
struct Private;
std::unique_ptr<Private> p;
};
#endif /* ECLIPSEHELP_H */
|
