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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/******************************************************************************
*
* $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.
*
*/
#include "namespacedef.h"
#include "outputlist.h"
#include "util.h"
#include "scanner.h"
#include "language.h"
#include "classdef.h"
#include "classlist.h"
#include "memberlist.h"
NamespaceDef::NamespaceDef(const char *name) : Definition(name)
{
fileName="namespace_"+nameToFile(name);
classList = new ClassList;
memList = new MemberList;
}
NamespaceDef::~NamespaceDef()
{
delete classList;
delete memList;
}
void NamespaceDef::insertUsedFile(const char *f)
{
if (files.find(f)==-1) files.append(f);
}
void NamespaceDef::insertClass(ClassDef *cd)
{
classList->append(cd);
}
void NamespaceDef::insertMember(MemberDef *md)
{
memList->append(md);
}
void NamespaceDef::computeAnchors()
{
setAnchors('a',memList);
}
void NamespaceDef::writeDocumentation(OutputList &ol)
{
QString pageTitle=name()+" Namespace Reference";
startFile(ol,fileName,pageTitle);
startTitle(ol);
ol.docify(pageTitle);
endTitle(ol,name());
OutputList briefOutput(&ol);
if (briefDescription())
{
parseDoc(briefOutput,0,0,briefDescription());
ol+=briefOutput;
ol.writeString(" \n");
ol.disableAllBut(OutputGenerator::Html);
ol.startTextLink(0,"details");
parseDoc(ol,0,0,theTranslator->trMore());
ol.endTextLink();
ol.enableAll();
}
ol.disable(OutputGenerator::Man);
ol.newParagraph();
ol.enable(OutputGenerator::Man);
ol.writeSynopsis();
if (classList->count()>0)
{
ClassDef *cd=classList->first();
bool found=FALSE;
while (cd)
{
if (cd->isVisibleExt())
{
if (!found)
{
ol.startMemberHeader();
parseDoc(ol,0,0,theTranslator->trCompounds());
ol.endMemberHeader();
ol.startMemberList();
found=TRUE;
}
QString clName=cd->name().copy();
if (clName.left(name().length()+2)==name()+"::")
{
clName = clName.right(clName.length()-name().length()-2);
}
ol.startMemberItem();
switch (cd->compoundType())
{
case ClassDef::Class: ol.writeString("class"); break;
case ClassDef::Struct: ol.writeString("struct"); break;
case ClassDef::Union: ol.writeString("union"); break;
}
ol.writeString(" ");
if (cd->hasDocumentation())
{
ol.writeObjectLink(cd->getReference(),
cd->classFile(),
0,
clName
);
}
else
{
ol.startBold();
ol.docify(clName);
ol.endBold();
}
ol.endMemberItem();
}
cd=classList->next();
}
if (found) ol.endMemberList();
}
writeMemberDecs(ol,0,this,0,0,0,memList);
if (!briefDescription().isEmpty() || !documentation().isEmpty())
{
ol.writeRuler();
ol.writeAnchor("details");
ol.startGroupHeader();
parseDoc(ol,0,0,theTranslator->trDetailedDescription());
ol.endGroupHeader();
if (!briefDescription().isEmpty())
{
ol+=briefOutput;
ol.newParagraph();
}
if (!documentation().isEmpty())
{
parseDoc(ol,0,0,documentation()+"\n");
ol.newParagraph();
}
}
memList->countDocMembers();
if ( memList->protoCount()>0 )
{
ol.writeRuler();
ol.startGroupHeader();
parseDoc(ol,0,0,theTranslator->trFunctionPrototypeDocumentation());
ol.endGroupHeader();
writeMemberDocs(ol,memList,name(),MemberDef::Prototype);
}
if ( memList->typedefCount()>0 )
{
ol.writeRuler();
ol.startGroupHeader();
parseDoc(ol,0,0,theTranslator->trTypedefDocumentation());
ol.endGroupHeader();
writeMemberDocs(ol,memList,name(),MemberDef::Typedef);
}
if ( memList->enumCount()>0 )
{
ol.writeRuler();
ol.startGroupHeader();
parseDoc(ol,0,0,theTranslator->trEnumerationTypeDocumentation());
ol.endGroupHeader();
writeMemberDocs(ol,memList,name(),MemberDef::Enumeration);
}
if ( memList->enumValueCount()>0 )
{
ol.writeRuler();
ol.startGroupHeader();
parseDoc(ol,0,0,theTranslator->trEnumerationValueDocumentation());
ol.endGroupHeader();
writeMemberDocs(ol,memList,name(),MemberDef::EnumValue);
}
if ( memList->funcCount()>0 )
{
ol.writeRuler();
ol.startGroupHeader();
parseDoc(ol,0,0,theTranslator->trFunctionDocumentation());
ol.endGroupHeader();
writeMemberDocs(ol,memList,name(),MemberDef::Function);
}
if ( memList->varCount()>0 )
{
ol.writeRuler();
ol.startGroupHeader();
parseDoc(ol,0,0,theTranslator->trVariableDocumentation());
ol.endGroupHeader();
writeMemberDocs(ol,memList,name(),MemberDef::Variable);
}
// write Author section (Man only)
ol.disableAllBut(OutputGenerator::Man);
ol.startGroupHeader();
parseDoc(ol,0,0,theTranslator->trAuthor());
ol.endGroupHeader();
parseDoc(ol,0,0,theTranslator->trGeneratedAutomatically(projectName));
ol.enableAll();
endFile(ol);
}
|
