blob: c42566dca49d2f00b3d8239c3747b61617642f75 (
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
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Doxygen: Perl Module Tree Nodes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen_manual.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Doxygen
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('perlmod_tree.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">Perl Module Tree Nodes </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h2>Nodes in the documentation tree of the Perl Module output format.</h2>
<p>This is a description of the structure of the documentation tree in <b>DoxyDocs.pm</b>. Each item in the list below describes a node in the tree, and the format of the description is as follows:</p>
<ul>
<li>
[ key => ] <b>Name</b> <em>(type)</em>. Explanation of the content. </li>
</ul>
<p>Where</p>
<ul>
<li>
<p class="startli">The "key =>" part only appears if the parent node is a hash. "key" is the key for this node.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli"><b>"Name"</b> is a unique name for the node, defined in DoxyModel.pm.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli"><em>"(type)"</em> is the type of the node: "string" for string nodes, "hash" for hash nodes, "list" for list nodes, and "doc" for documentation subtrees. The structure of documentation subtrees is not described anywhere yet, but you can look for example at <b>doxylatex.pl</b> to see how to process it.</p>
<p class="endli"></p>
</li>
</ul>
<p>The meaning of each node in the documentation tree is as follows: </p><ul>
<li>
<b>Root</b> <em>(hash)</em>. Root node. <ul>
<li>
classes => <b>Classes</b> <em>(list)</em>. Documented classes. <ul>
<li>
<b>Class</b> <em>(hash)</em>. A documented class. <ul>
<li>
protected_members => <b>ClassProtectedMembers</b> <em>(hash)</em>. Information about the protected members in the class. <ul>
<li>
members => <b>ClassProtectedMemberList</b> <em>(list)</em>. protected member list. <ul>
<li>
<b>ClassProtectedMember</b> <em>(hash)</em>. A protected member. <ul>
<li>
protection => <b>ClassProtectedMemberProtection</b> <em>(string)</em>. Protection of the protected member. </li>
<li>
detailed => <b>ClassProtectedMemberDetailed</b> <em>(hash)</em>. Detailed information about the protected member. <ul>
<li>
doc => <b>ClassProtectedMemberDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the protected member. </li>
<li>
see => <b>ClassProtectedMemberSee</b> <em>(doc)</em>. "See also" documentation for the protected member. </li>
</ul>
</li>
<li>
kind => <b>ClassProtectedMemberKind</b> <em>(string)</em>. Kind of protected member (usually "variable"). </li>
<li>
name => <b>ClassProtectedMemberName</b> <em>(string)</em>. Name of the protected member. </li>
<li>
type => <b>ClassProtectedMemberType</b> <em>(string)</em>. Data type of the protected member. </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
detailed => <b>ClassDetailed</b> <em>(hash)</em>. Detailed information about the class. <ul>
<li>
doc => <b>ClassDetailedDoc</b> <em>(doc)</em>. Detailed documentation block for the class. </li>
</ul>
</li>
<li>
protected_typedefs => <b>ClassProtectedTypedefs</b> <em>(hash)</em>. Information about the protected typedefs in the class. <ul>
<li>
members => <b>ClassProtectedTypedefList</b> <em>(list)</em>. protected typedef list. <ul>
<li>
<b>ClassProtectedTypedef</b> <em>(hash)</em>. A protected typedef. <ul>
<li>
protection => <b>ClassProtectedTypedefProtection</b> <em>(string)</em>. Protection of the protected typedef. </li>
<li>
detailed => <b>ClassProtectedTypedefDetailed</b> <em>(hash)</em>. Detailed information about the protected typedef. <ul>
<li>
doc => <b>ClassProtectedTypedefDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the protected typedef. </li>
<li>
see => <b>ClassProtectedTypedefSee</b> <em>(doc)</em>. "See also" documentation for the protected typedef. </li>
</ul>
</li>
<li>
kind => <b>ClassProtectedTypedefKind</b> <em>(string)</em>. Kind of protected typedef (usually "typedef"). </li>
<li>
name => <b>ClassProtectedTypedefName</b> <em>(string)</em>. Name of the protected typedef. </li>
<li>
type => <b>ClassProtectedTypedefType</b> <em>(string)</em>. Data type of the protected typedef. </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
name => <b>ClassName</b> <em>(string)</em>. Name of the class. </li>
<li>
private_members => <b>ClassPrivateMembers</b> <em>(hash)</em>. Information about the private members in the class. <ul>
<li>
members => <b>ClassPrivateMemberList</b> <em>(list)</em>. private member list. <ul>
<li>
<b>ClassPrivateMember</b> <em>(hash)</em>. A private member. <ul>
<li>
protection => <b>ClassPrivateMemberProtection</b> <em>(string)</em>. Protection of the private member. </li>
<li>
detailed => <b>ClassPrivateMemberDetailed</b> <em>(hash)</em>. Detailed information about the private member. <ul>
<li>
doc => <b>ClassPrivateMemberDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the private member. </li>
<li>
see => <b>ClassPrivateMemberSee</b> <em>(doc)</em>. "See also" documentation for the private member. </li>
</ul>
</li>
<li>
kind => <b>ClassPrivateMemberKind</b> <em>(string)</em>. Kind of private member (usually "variable"). </li>
<li>
name => <b>ClassPrivateMemberName</b> <em>(string)</em>. Name of the private member. </li>
<li>
type => <b>ClassPrivateMemberType</b> <em>(string)</em>. Data type of the private member. </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
private_typedefs => <b>ClassPrivateTypedefs</b> <em>(hash)</em>. Information about the private typedefs in the class. <ul>
<li>
members => <b>ClassPrivateTypedefList</b> <em>(list)</em>. private typedef list. <ul>
<li>
<b>ClassPrivateTypedef</b> <em>(hash)</em>. A private typedef. <ul>
<li>
protection => <b>ClassPrivateTypedefProtection</b> <em>(string)</em>. Protection of the private typedef. </li>
<li>
detailed => <b>ClassPrivateTypedefDetailed</b> <em>(hash)</em>. Detailed information about the private typedef. <ul>
<li>
doc => <b>ClassPrivateTypedefDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the private typedef. </li>
<li>
see => <b>ClassPrivateTypedefSee</b> <em>(doc)</em>. "See also" documentation for the private typedef. </li>
</ul>
</li>
<li>
kind => <b>ClassPrivateTypedefKind</b> <em>(string)</em>. Kind of private typedef (usually "typedef"). </li>
<li>
name => <b>ClassPrivateTypedefName</b> <em>(string)</em>. Name of the private typedef. </li>
<li>
type => <b>ClassPrivateTypedefType</b> <em>(string)</em>. Data type of the private typedef. </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
protected_methods => <b>ClassProtectedMethods</b> <em>(hash)</em>. Information about the protected methods in the class. <ul>
<li>
members => <b>ClassProtectedMethodList</b> <em>(list)</em>. protected method list. <ul>
<li>
<b>ClassProtectedMethod</b> <em>(hash)</em>. A protected method. <ul>
<li>
parameters => <b>ClassProtectedMethodParams</b> <em>(list)</em>. List of the parameters of the protected method. <ul>
<li>
<b>ClassProtectedMethodParam</b> <em>(hash)</em>. A parameter of the protected method. <ul>
<li>
declaration_name => <b>ClassProtectedMethodParamName</b> <em>(string)</em>. The name of the parameter. </li>
<li>
type => <b>ClassProtectedMethodParamType</b> <em>(string)</em>. The data type of the parameter. </li>
</ul>
</li>
</ul>
</li>
<li>
protection => <b>ClassProtectedMethodProtection</b> <em>(string)</em>. Protection of the protected method. </li>
<li>
virtualness => <b>ClassProtectedMethodVirtualness</b> <em>(string)</em>. Virtualness of the protected method. </li>
<li>
detailed => <b>ClassProtectedMethodDetailed</b> <em>(hash)</em>. Detailed information about the protected method. <ul>
<li>
params => <b>ClassProtectedMethodPDBlocks</b> <em>(list)</em>. List of parameter documentation blocks for the protected method. <ul>
<li>
<b>ClassProtectedMethodPDBlock</b> <em>(hash)</em>. A parameter documentation block for the protected method. <ul>
<li>
parameters => <b>ClassProtectedMethodPDParams</b> <em>(list)</em>. Parameter list for this parameter documentation block. <ul>
<li>
<b>ClassProtectedMethodPDParam</b> <em>(hash)</em>. A parameter documented by this documentation block. <ul>
<li>
name => <b>ClassProtectedMethodPDParamName</b> <em>(string)</em>. Name of the parameter. </li>
</ul>
</li>
</ul>
</li>
<li>
doc => <b>ClassProtectedMethodPDDoc</b> <em>(doc)</em>. Documentation for this parameter documentation block. </li>
</ul>
</li>
</ul>
</li>
<li>
doc => <b>ClassProtectedMethodDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the protected method. </li>
<li>
see => <b>ClassProtectedMethodSee</b> <em>(doc)</em>. "See also" documentation for the protected method. </li>
<li>
return => <b>ClassProtectedMethodReturn</b> <em>(doc)</em>. Documentation about the return value of the protected method. </li>
</ul>
</li>
<li>
kind => <b>ClassProtectedMethodKind</b> <em>(string)</em>. Kind of protected method (usually "function"). </li>
<li>
name => <b>ClassProtectedMethodName</b> <em>(string)</em>. Name of the protected method. </li>
<li>
type => <b>ClassProtectedMethodType</b> <em>(string)</em>. Data type returned by the protected method. </li>
<li>
static => <b>ClassProtectedMethodStatic</b> <em>(string)</em>. Whether the protected method is static. </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
public_typedefs => <b>ClassPublicTypedefs</b> <em>(hash)</em>. Information about the public typedefs in the class. <ul>
<li>
members => <b>ClassPublicTypedefList</b> <em>(list)</em>. public typedef list. <ul>
<li>
<b>ClassPublicTypedef</b> <em>(hash)</em>. A public typedef. <ul>
<li>
protection => <b>ClassPublicTypedefProtection</b> <em>(string)</em>. Protection of the public typedef. </li>
<li>
detailed => <b>ClassPublicTypedefDetailed</b> <em>(hash)</em>. Detailed information about the public typedef. <ul>
<li>
doc => <b>ClassPublicTypedefDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the public typedef. </li>
<li>
see => <b>ClassPublicTypedefSee</b> <em>(doc)</em>. "See also" documentation for the public typedef. </li>
</ul>
</li>
<li>
kind => <b>ClassPublicTypedefKind</b> <em>(string)</em>. Kind of public typedef (usually "typedef"). </li>
<li>
name => <b>ClassPublicTypedefName</b> <em>(string)</em>. Name of the public typedef. </li>
<li>
type => <b>ClassPublicTypedefType</b> <em>(string)</em>. Data type of the public typedef. </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
public_members => <b>ClassPublicMembers</b> <em>(hash)</em>. Information about the public members in the class. <ul>
<li>
members => <b>ClassPublicMemberList</b> <em>(list)</em>. public member list. <ul>
<li>
<b>ClassPublicMember</b> <em>(hash)</em>. A public member. <ul>
<li>
protection => <b>ClassPublicMemberProtection</b> <em>(string)</em>. Protection of the public member. </li>
<li>
detailed => <b>ClassPublicMemberDetailed</b> <em>(hash)</em>. Detailed information about the public member. <ul>
<li>
doc => <b>ClassPublicMemberDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the public member. </li>
<li>
see => <b>ClassPublicMemberSee</b> <em>(doc)</em>. "See also" documentation for the public member. </li>
</ul>
</li>
<li>
kind => <b>ClassPublicMemberKind</b> <em>(string)</em>. Kind of public member (usually "variable"). </li>
<li>
name => <b>ClassPublicMemberName</b> <em>(string)</em>. Name of the public member. </li>
<li>
type => <b>ClassPublicMemberType</b> <em>(string)</em>. Data type of the public member. </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
private_methods => <b>ClassPrivateMethods</b> <em>(hash)</em>. Information about the private methods in the class. <ul>
<li>
members => <b>ClassPrivateMethodList</b> <em>(list)</em>. private method list. <ul>
<li>
<b>ClassPrivateMethod</b> <em>(hash)</em>. A private method. <ul>
<li>
parameters => <b>ClassPrivateMethodParams</b> <em>(list)</em>. List of the parameters of the private method. <ul>
<li>
<b>ClassPrivateMethodParam</b> <em>(hash)</em>. A parameter of the private method. <ul>
<li>
declaration_name => <b>ClassPrivateMethodParamName</b> <em>(string)</em>. The name of the parameter. </li>
<li>
type => <b>ClassPrivateMethodParamType</b> <em>(string)</em>. The data type of the parameter. </li>
</ul>
</li>
</ul>
</li>
<li>
protection => <b>ClassPrivateMethodProtection</b> <em>(string)</em>. Protection of the private method. </li>
<li>
virtualness => <b>ClassPrivateMethodVirtualness</b> <em>(string)</em>. Virtualness of the private method. </li>
<li>
detailed => <b>ClassPrivateMethodDetailed</b> <em>(hash)</em>. Detailed information about the private method. <ul>
<li>
params => <b>ClassPrivateMethodPDBlocks</b> <em>(list)</em>. List of parameter documentation blocks for the private method. <ul>
<li>
<b>ClassPrivateMethodPDBlock</b> <em>(hash)</em>. A parameter documentation block for the private method. <ul>
<li>
parameters => <b>ClassPrivateMethodPDParams</b> <em>(list)</em>. Parameter list for this parameter documentation block. <ul>
<li>
<b>ClassPrivateMethodPDParam</b> <em>(hash)</em>. A parameter documented by this documentation block. <ul>
<li>
name => <b>ClassPrivateMethodPDParamName</b> <em>(string)</em>. Name of the parameter. </li>
</ul>
</li>
</ul>
</li>
<li>
doc => <b>ClassPrivateMethodPDDoc</b> <em>(doc)</em>. Documentation for this parameter documentation block. </li>
</ul>
</li>
</ul>
</li>
<li>
doc => <b>ClassPrivateMethodDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the private method. </li>
<li>
see => <b>ClassPrivateMethodSee</b> <em>(doc)</em>. "See also" documentation for the private method. </li>
<li>
return => <b>ClassPrivateMethodReturn</b> <em>(doc)</em>. Documentation about the return value of the private method. </li>
</ul>
</li>
<li>
kind => <b>ClassPrivateMethodKind</b> <em>(string)</em>. Kind of private method (usually "function"). </li>
<li>
name => <b>ClassPrivateMethodName</b> <em>(string)</em>. Name of the private method. </li>
<li>
type => <b>ClassPrivateMethodType</b> <em>(string)</em>. Data type returned by the private method. </li>
<li>
static => <b>ClassPrivateMethodStatic</b> <em>(string)</em>. Whether the private method is static. </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
public_methods => <b>ClassPublicMethods</b> <em>(hash)</em>. Information about the public methods in the class. <ul>
<li>
members => <b>ClassPublicMethodList</b> <em>(list)</em>. public method list. <ul>
<li>
<b>ClassPublicMethod</b> <em>(hash)</em>. A public method. <ul>
<li>
parameters => <b>ClassPublicMethodParams</b> <em>(list)</em>. List of the parameters of the public method. <ul>
<li>
<b>ClassPublicMethodParam</b> <em>(hash)</em>. A parameter of the public method. <ul>
<li>
declaration_name => <b>ClassPublicMethodParamName</b> <em>(string)</em>. The name of the parameter. </li>
<li>
type => <b>ClassPublicMethodParamType</b> <em>(string)</em>. The data type of the parameter. </li>
</ul>
</li>
</ul>
</li>
<li>
protection => <b>ClassPublicMethodProtection</b> <em>(string)</em>. Protection of the public method. </li>
<li>
virtualness => <b>ClassPublicMethodVirtualness</b> <em>(string)</em>. Virtualness of the public method. </li>
<li>
detailed => <b>ClassPublicMethodDetailed</b> <em>(hash)</em>. Detailed information about the public method. <ul>
<li>
params => <b>ClassPublicMethodPDBlocks</b> <em>(list)</em>. List of parameter documentation blocks for the public method. <ul>
<li>
<b>ClassPublicMethodPDBlock</b> <em>(hash)</em>. A parameter documentation block for the public method. <ul>
<li>
parameters => <b>ClassPublicMethodPDParams</b> <em>(list)</em>. Parameter list for this parameter documentation block. <ul>
<li>
<b>ClassPublicMethodPDParam</b> <em>(hash)</em>. A parameter documented by this documentation block. <ul>
<li>
name => <b>ClassPublicMethodPDParamName</b> <em>(string)</em>. Name of the parameter. </li>
</ul>
</li>
</ul>
</li>
<li>
doc => <b>ClassPublicMethodPDDoc</b> <em>(doc)</em>. Documentation for this parameter documentation block. </li>
</ul>
</li>
</ul>
</li>
<li>
doc => <b>ClassPublicMethodDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the public method. </li>
<li>
see => <b>ClassPublicMethodSee</b> <em>(doc)</em>. "See also" documentation for the public method. </li>
<li>
return => <b>ClassPublicMethodReturn</b> <em>(doc)</em>. Documentation about the return value of the public method. </li>
</ul>
</li>
<li>
kind => <b>ClassPublicMethodKind</b> <em>(string)</em>. Kind of public method (usually "function"). </li>
<li>
name => <b>ClassPublicMethodName</b> <em>(string)</em>. Name of the public method. </li>
<li>
type => <b>ClassPublicMethodType</b> <em>(string)</em>. Data type returned by the public method. </li>
<li>
static => <b>ClassPublicMethodStatic</b> <em>(string)</em>. Whether the public method is static. </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
files => <b>Files</b> <em>(list)</em>. Documented files. <ul>
<li>
<b>File</b> <em>(hash)</em>. A documented file. <ul>
<li>
detailed => <b>FileDetailed</b> <em>(hash)</em>. Detailed information about the file. <ul>
<li>
doc => <b>FileDetailedDoc</b> <em>(doc)</em>. Detailed documentation block for the file. </li>
</ul>
</li>
<li>
functions => <b>FileFunctions</b> <em>(hash)</em>. Information about the functions in the file. <ul>
<li>
members => <b>FileFunctionList</b> <em>(list)</em>. function list. <ul>
<li>
<b>FileFunction</b> <em>(hash)</em>. A function. <ul>
<li>
parameters => <b>FileFunctionParams</b> <em>(list)</em>. List of the parameters of the function. <ul>
<li>
<b>FileFunctionParam</b> <em>(hash)</em>. A parameter of the function. <ul>
<li>
declaration_name => <b>FileFunctionParamName</b> <em>(string)</em>. The name of the parameter. </li>
<li>
type => <b>FileFunctionParamType</b> <em>(string)</em>. The data type of the parameter. </li>
</ul>
</li>
</ul>
</li>
<li>
protection => <b>FileFunctionProtection</b> <em>(string)</em>. Protection of the function. </li>
<li>
virtualness => <b>FileFunctionVirtualness</b> <em>(string)</em>. Virtualness of the function. </li>
<li>
detailed => <b>FileFunctionDetailed</b> <em>(hash)</em>. Detailed information about the function. <ul>
<li>
params => <b>FileFunctionPDBlocks</b> <em>(list)</em>. List of parameter documentation blocks for the function. <ul>
<li>
<b>FileFunctionPDBlock</b> <em>(hash)</em>. A parameter documentation block for the function. <ul>
<li>
parameters => <b>FileFunctionPDParams</b> <em>(list)</em>. Parameter list for this parameter documentation block. <ul>
<li>
<b>FileFunctionPDParam</b> <em>(hash)</em>. A parameter documented by this documentation block. <ul>
<li>
name => <b>FileFunctionPDParamName</b> <em>(string)</em>. Name of the parameter. </li>
</ul>
</li>
</ul>
</li>
<li>
doc => <b>FileFunctionPDDoc</b> <em>(doc)</em>. Documentation for this parameter documentation block. </li>
</ul>
</li>
</ul>
</li>
<li>
doc => <b>FileFunctionDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the function. </li>
<li>
see => <b>FileFunctionSee</b> <em>(doc)</em>. "See also" documentation for the function. </li>
<li>
return => <b>FileFunctionReturn</b> <em>(doc)</em>. Documentation about the return value of the function. </li>
</ul>
</li>
<li>
kind => <b>FileFunctionKind</b> <em>(string)</em>. Kind of function (usually "function"). </li>
<li>
name => <b>FileFunctionName</b> <em>(string)</em>. Name of the function. </li>
<li>
type => <b>FileFunctionType</b> <em>(string)</em>. Data type returned by the function. </li>
<li>
static => <b>FileFunctionStatic</b> <em>(string)</em>. Whether the function is static. </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
name => <b>FileName</b> <em>(string)</em>. Name of the file. </li>
<li>
variables => <b>FileVariables</b> <em>(hash)</em>. Information about the variables in the file. <ul>
<li>
members => <b>FileVariableList</b> <em>(list)</em>. variable list. <ul>
<li>
<b>FileVariable</b> <em>(hash)</em>. A variable. <ul>
<li>
protection => <b>FileVariableProtection</b> <em>(string)</em>. Protection of the variable. </li>
<li>
detailed => <b>FileVariableDetailed</b> <em>(hash)</em>. Detailed information about the variable. <ul>
<li>
doc => <b>FileVariableDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the variable. </li>
<li>
see => <b>FileVariableSee</b> <em>(doc)</em>. "See also" documentation for the variable. </li>
</ul>
</li>
<li>
kind => <b>FileVariableKind</b> <em>(string)</em>. Kind of variable (usually "variable"). </li>
<li>
name => <b>FileVariableName</b> <em>(string)</em>. Name of the variable. </li>
<li>
type => <b>FileVariableType</b> <em>(string)</em>. Data type of the variable. </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
typedefs => <b>FileTypedefs</b> <em>(hash)</em>. Information about the typedefs in the file. <ul>
<li>
members => <b>FileTypedefList</b> <em>(list)</em>. typedef list. <ul>
<li>
<b>FileTypedef</b> <em>(hash)</em>. A typedef. <ul>
<li>
protection => <b>FileTypedefProtection</b> <em>(string)</em>. Protection of the typedef. </li>
<li>
detailed => <b>FileTypedefDetailed</b> <em>(hash)</em>. Detailed information about the typedef. <ul>
<li>
doc => <b>FileTypedefDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the typedef. </li>
<li>
see => <b>FileTypedefSee</b> <em>(doc)</em>. "See also" documentation for the typedef. </li>
</ul>
</li>
<li>
kind => <b>FileTypedefKind</b> <em>(string)</em>. Kind of typedef (usually "typedef"). </li>
<li>
name => <b>FileTypedefName</b> <em>(string)</em>. Name of the typedef. </li>
<li>
type => <b>FileTypedefType</b> <em>(string)</em>. Data type of the typedef. </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>
Go to the <a href="arch.html">next</a> section or return to the
<a href="index.html">index</a>.
</p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
</ul>
</div>
</body>
</html>
|
