blob: 48301bcd7456a774a63888cd528afe0570f76c13 (
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
|
/******************************************************************************
*
* $Id$
*
* Copyright (C) 1997-1999 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.
*
* All output generated with Doxygen is not covered by this license.
*
*/
#ifndef DEFINITION_H
#define DEFINITION_H
#include <qstring.h>
#include <qlist.h>
#include "config.h"
#include "section.h"
/*! The common base class of all definitions. */
class Definition
{
public:
//! create a new definition
Definition(const char *name,const char *b=0,const char *d=0);
//! destroys the definition
virtual ~Definition();
//! returns the name of the definition
QString name() const { return n; }
//! returns the base name of the output file that contains this definition.
virtual QString getOutputFileBase() const = 0;
//! returns the detailed description of this definition
QString documentation() const { return doc; }
//! returns the brief description of this definition
QString briefDescription() const { return brief; }
//! sets a new name for the definition
void setName(const char *name) { n=name; }
//! sets the documentation of this definition
void setDocumentation(const char *d)
{
doc=d; doc=doc.stripWhiteSpace();
}
//! sets the brief description of this definition
void setBriefDescription(const char *b)
{
brief=b; brief=brief.stripWhiteSpace();
int bl=brief.length();
if (bl>0 && brief.at(bl-1)!='.' && brief.at(bl-1)!='!' &&
brief.at(bl-1)!='?') brief+='.';
}
//! returns TRUE iff the definition is documented
bool hasDocumentation()
{ return !doc.isNull() || !brief.isNull() || extractAllFlag; }
QString nameToFile(const char *name);
void addSectionsToDefinition(QList<QString> *anchorList);
private:
QString n; // name of the definition
QString brief; // brief description
QString doc; // detailed description
SectionList *sectionList; // list of all sections
};
#endif
|
