/
commands.doc
4133 lines (3313 loc) · 146 KB
/
commands.doc
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
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/******************************************************************************
*
*
*
* 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.
*
*/
/*! \page commands Special Commands
\section cmd_intro Introduction
All commands in the documentation start with a backslash (<b>\\</b>) or an
at-sign (<b>\@</b>). If you prefer you can replace all commands starting with a
backslash below by their counterparts that start with an at-sign.
Some commands have one or more arguments.
Each argument has a certain range:
<ul>
<li>If \<sharp\> braces are used the argument is a single word.
<li>If (round) braces are used the argument extends until the end of the line
on which the command was found.
<li>If {curly} braces are used the argument extends until the next paragraph.
Paragraphs are delimited by a blank line or by a section indicator. Note that
{curly} braces are also used for command options, here the braces are mandatory
and just 'normal' characters. The starting curly brace has to directly follow
the command, so without whitespace.
</ul>
If in addition to the above argument specifiers [square] brackets are used the argument
is optional, unless they are placed between quotes in that case they are a mandatory
part of the command argument.
Here is an alphabetically sorted list of all commands with references to their
documentation:
\anchor showsecreflist
\secreflist
\refitem cmda \\a
\refitem cmdaddindex \\addindex
\refitem cmdaddtogroup \\addtogroup
\refitem cmdanchor \\anchor
\refitem cmdarg \\arg
\refitem cmdattention \\attention
\refitem cmdauthor \\author
\refitem cmdauthors \\authors
\refitem cmdb \\b
\refitem cmdbrief \\brief
\refitem cmdbug \\bug
\refitem cmdc \\c
\refitem cmdcallergraph \\callergraph
\refitem cmdcallgraph \\callgraph
\refitem cmdcategory \\category
\refitem cmdcite \\cite
\refitem cmdclass \\class
\refitem cmdcode \\code
\refitem cmdcollaborationgraph \\collaborationgraph
\refitem cmdconcept \\concept
\refitem cmdcond \\cond
\refitem cmdcopybrief \\copybrief
\refitem cmdcopydetails \\copydetails
\refitem cmdcopydoc \\copydoc
\refitem cmdcopyright \\copyright
\refitem cmddate \\date
\refitem cmddef \\def
\refitem cmddefgroup \\defgroup
\refitem cmddeprecated \\deprecated
\refitem cmddetails \\details
\refitem cmddiafile \\diafile
\refitem cmddir \\dir
\refitem cmddirectorygraph \\directorygraph
\refitem cmddocbookinclude \\docbookinclude
\refitem cmddocbookonly \\docbookonly
\refitem cmddontinclude \\dontinclude
\refitem cmddot \\dot
\refitem cmddotfile \\dotfile
\refitem cmddoxyconfig \\doxyconfig
\refitem cmde \\e
\refitem cmdelse \\else
\refitem cmdelseif \\elseif
\refitem cmdem \\em
\refitem cmdemoji \\emoji
\refitem cmdendcode \\endcode
\refitem cmdendcond \\endcond
\refitem cmdenddocbookonly \\enddocbookonly
\refitem cmdenddot \\enddot
\refitem cmdendhtmlonly \\endhtmlonly
\refitem cmdendif \\endif
\refitem cmdendinternal \\endinternal
\refitem cmdendlatexonly \\endlatexonly
\refitem cmdendlink \\endlink
\refitem cmdendmanonly \\endmanonly
\refitem cmdendmsc \\endmsc
\refitem cmdendparblock \\endparblock
\refitem cmdendrtfonly \\endrtfonly
\refitem cmdendsecreflist \\endsecreflist
\refitem cmdendverbatim \\endverbatim
\refitem cmdenduml \\enduml
\refitem cmdendxmlonly \\endxmlonly
\refitem cmdenum \\enum
\refitem cmdexample \\example
\refitem cmdexception \\exception
\refitem cmdextends \\extends
\refitem cmdfrndopen \\f(
\refitem cmdfrndclose \\f)
\refitem cmdfdollar \\f\$
\refitem cmdfbropen \\f[
\refitem cmdfbrclose \\f]
\refitem cmdfcurlyopen \\f{
\refitem cmdfcurlyclose \\f}
\refitem cmdfile \\file
\refitem cmdfileinfo \\fileinfo
\refitem cmdfn \\fn
\refitem cmdgroupgraph \\groupgraph
\refitem cmdheaderfile \\headerfile
\refitem cmdhidecallergraph \\hidecallergraph
\refitem cmdhidecallgraph \\hidecallgraph
\refitem cmdhidecollaborationgraph \\hidecollaborationgraph
\refitem cmdhidedirectorygraph \\hidedirectorygraph
\refitem cmdhidegroupgraph \\hidegroupgraph
\refitem cmdhideincludedbygraph \\hideincludedbygraph
\refitem cmdhideincludegraph \\hideincludegraph
\refitem cmdhideinheritancegraph \\hideinheritancegraph
\refitem cmdhiderefby \\hiderefby
\refitem cmdhiderefs \\hiderefs
\refitem cmdhideinitializer \\hideinitializer
\refitem cmdhtmlinclude \\htmlinclude
\refitem cmdhtmlonly \\htmlonly
\refitem cmdidlexcept \\idlexcept
\refitem cmdif \\if
\refitem cmdifnot \\ifnot
\refitem cmdimage \\image
\refitem cmdimplements \\implements
\refitem cmdinclude \\include
\refitem cmdincludedoc \\includedoc
\refitem cmdincludedbygraph \\includedbygraph
\refitem cmdincludegraph \\includegraph
\refitem cmdincludelineno \\includelineno
\refitem cmdingroup \\ingroup
\refitem cmdinheritancegraph \\inheritancegraph
\refitem cmdinternal \\internal
\refitem cmdinvariant \\invariant
\refitem cmdinterface \\interface
\refitem cmdlatexinclude \\latexinclude
\refitem cmdlatexonly \\latexonly
\refitem cmdli \\li
\refitem cmdline \\line
\refitem cmdlineinfo \\lineinfo
\refitem cmdlink \\link
\refitem cmdmainpage \\mainpage
\refitem cmdmaninclude \\maninclude
\refitem cmdmanonly \\manonly
\refitem cmdmemberof \\memberof
\refitem cmdmodule \\module
\refitem cmdmsc \\msc
\refitem cmdmscfile \\mscfile
\refitem cmdn \\n
\refitem cmdname \\name
\refitem cmdnamespace \\namespace
\refitem cmdnoop \\noop
\refitem cmdnosubgrouping \\nosubgrouping
\refitem cmdnote \\note
\refitem cmdoverload \\overload
\refitem cmdp \\p
\refitem cmdpackage \\package
\refitem cmdpage \\page
\refitem cmdpar \\par
\refitem cmdparagraph \\paragraph
\refitem cmdparam \\param
\refitem cmdparblock \\parblock
\refitem cmdpost \\post
\refitem cmdpre \\pre
\refitem cmdprivate \\private
\refitem cmdprivatesection \\privatesection
\refitem cmdproperty \\property
\refitem cmdprotected \\protected
\refitem cmdprotectedsection \\protectedsection
\refitem cmdprotocol \\protocol
\refitem cmdpublic \\public
\refitem cmdpublicsection \\publicsection
\refitem cmdpure \\pure
\refitem cmdqualifier \\qualifier
\refitem cmdraisewarning \\raisewarning
\refitem cmdref \\ref
\refitem cmdrefitem \\refitem
\refitem cmdrelated \\related
\refitem cmdrelates \\relates
\refitem cmdrelatedalso \\relatedalso
\refitem cmdrelatesalso \\relatesalso
\refitem cmdremark \\remark
\refitem cmdremarks \\remarks
\refitem cmdresult \\result
\refitem cmdreturn \\return
\refitem cmdreturns \\returns
\refitem cmdretval \\retval
\refitem cmdrtfinclude \\rtfinclude
\refitem cmdrtfonly \\rtfonly
\refitem cmdsa \\sa
\refitem cmdsecreflist \\secreflist
\refitem cmdsection \\section
\refitem cmdsee \\see
\refitem cmdshort \\short
\refitem cmdshowdate \\showdate
\refitem cmdshowinitializer \\showinitializer
\refitem cmdshowrefby \\showrefby
\refitem cmdshowrefs \\showrefs
\refitem cmdsince \\since
\refitem cmdskip \\skip
\refitem cmdskipline \\skipline
\refitem cmdsnippet \\snippet
\refitem cmdsnippetdoc \\snippetdoc
\refitem cmdsnippetlineno \\snippetlineno
\refitem cmdstatic \\static
\refitem cmdstartuml \\startuml
\refitem cmdstruct \\struct
\refitem cmdsubpage \\subpage
\refitem cmdsubsection \\subsection
\refitem cmdsubsubsection \\subsubsection
\refitem cmdtableofcontents \\tableofcontents
\refitem cmdtest \\test
\refitem cmdthrow \\throw
\refitem cmdthrows \\throws
\refitem cmdtodo \\todo
\refitem cmdtparam \\tparam
\refitem cmdtypedef \\typedef
\refitem cmdunion \\union
\refitem cmduntil \\until
\refitem cmdvar \\var
\refitem cmdverbatim \\verbatim
\refitem cmdverbinclude \\verbinclude
\refitem cmdversion \\version
\refitem cmdvhdlflow \\vhdlflow
\refitem cmdwarning \\warning
\refitem cmdweakgroup \\weakgroup
\refitem cmdxmlinclude \\xmlinclude
\refitem cmdxmlonly \\xmlonly
\refitem cmdxrefitem \\xrefitem
\refitem cmddollar \\\$
\refitem cmdat \\\@
\refitem cmdbackslash \\\\
\refitem cmdamp \\\&
\refitem cmdtilde \\~
\refitem cmdlt \\\<
\refitem cmdeq \\=
\refitem cmdgt \\\>
\refitem cmdhash \\\#
\refitem cmdperc \\\%
\refitem cmdquot \\\"
\refitem cmdchardot \\\.
\refitem cmddcolon \::
\refitem cmdpipe \\|
\refitem cmdndash \\\--
\refitem cmdmdash \\\---
\endsecreflist
The following subsections provide a list of all commands that are recognized by
doxygen. Unrecognized commands are treated as normal text.
\htmlonly</p><center><p>\endhtmlonly
<h2>
\htmlonly --- \endhtmlonly
Structural indicators
\htmlonly --- \endhtmlonly
</h2>
\htmlonly</p></center><p>\endhtmlonly
\section cmdaddtogroup \\addtogroup <name> [(title)]
\addindex \\addtogroup
Defines a group just like \ref cmddefgroup "\\defgroup", but in contrast to
that command using the same \<name\> more than once will not result in a warning,
but rather one group with a merged documentation and the first title found in
any of the commands.
The title is optional, so this command can also be used to add a number of
entities to an existing group using \c \@{ and \c \@} like this:
\verbatim
/*! \addtogroup mygrp
* Additional documentation for group 'mygrp'
* @{
*/
/*!
* A function
*/
void func1()
{
}
/*! Another function */
void func2()
{
}
/*! @} */
\endverbatim
\sa page \ref grouping "Grouping", sections \ref cmddefgroup "\\defgroup", \ref cmdingroup "\\ingroup", and
\ref cmdweakgroup "\\weakgroup".
<hr>
\section cmdcallgraph \\callgraph
\addindex \\callgraph
When this command is put in a comment block of a function or method
and \ref cfg_have_dot "HAVE_DOT" is set to \c YES, then doxygen will
generate a call graph for that function (provided the implementation of the
function or method calls other documented functions). The call graph will be
generated regardless of the value of \ref cfg_call_graph "CALL_GRAPH".
\note The completeness (and correctness) of the call graph depends on the
doxygen code parser which is not perfect.
\sa section \ref cmdcallergraph "\\callergraph",
section \ref cmdhidecallgraph "\\hidecallgraph",
section \ref cmdhidecallergraph "\\hidecallergraph" and
option \ref cfg_call_graph "CALL_GRAPH"
<hr>
\section cmdhidecallgraph \\hidecallgraph
\addindex \\hidecallgraph
When this command is put in a comment block of a function or method
and then doxygen will not generate a call graph for that function. The
call graph will not be generated regardless of the value of
\ref cfg_call_graph "CALL_GRAPH".
\note The completeness (and correctness) of the call graph depends on the
doxygen code parser which is not perfect.
\sa section \ref cmdcallergraph "\\callergraph",
section \ref cmdcallgraph "\\callgraph",
section \ref cmdhidecallergraph "\\hidecallergraph" and
option \ref cfg_call_graph "CALL_GRAPH"
<hr>
\section cmdcallergraph \\callergraph
\addindex \\callergraph
When this command is put in a comment block of a function or method
and \ref cfg_have_dot "HAVE_DOT" is set to \c YES, then doxygen will
generate a caller graph for that function (provided the implementation of the
function or method is called by other documented functions). The caller graph will be
generated regardless of the value of \ref cfg_caller_graph "CALLER_GRAPH".
\note The completeness (and correctness) of the caller graph depends on the
doxygen code parser which is not perfect.
\sa section \ref cmdcallgraph "\\callgraph",
section \ref cmdhidecallgraph "\\hidecallgraph",
section \ref cmdhidecallergraph "\\hidecallergraph" and
option \ref cfg_caller_graph "CALLER_GRAPH"
<hr>
\section cmdhidecallergraph \\hidecallergraph
\addindex \\hidecallergraph
When this command is put in a comment block of a function or method
and then doxygen will not generate a caller graph for that function. The
caller graph will not be generated regardless of the value of
\ref cfg_caller_graph "CALLER_GRAPH".
\note The completeness (and correctness) of the caller graph depends on the
doxygen code parser which is not perfect.
\sa section \ref cmdcallergraph "\\callergraph",
section \ref cmdcallgraph "\\callgraph",
section \ref cmdhidecallgraph "\\hidecallgraph" and
option \ref cfg_caller_graph "CALLER_GRAPH"
<hr>
\section cmdshowrefby \\showrefby
\addindex \\showrefby
When this command is put in a comment block of a function, method or variable,
then doxygen will generate an overview for that function, method, variable of
the, documented, functions and methods that call / use it.
The overview will be generated regardless of the value of
\ref cfg_referenced_by_relation "REFERENCED_BY_RELATION".
\note The completeness (and correctness) of the overview depends on the
doxygen code parser which is not perfect.
\sa section \ref cmdshowrefs "\\showrefs",
section \ref cmdhiderefby "\\hiderefby",
section \ref cmdhiderefs "\\hiderefs" and
option \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION"
<hr>
\section cmdhiderefby \\hiderefby
\addindex \\hiderefby
When this command is put in a comment block of a function, method or variable
then doxygen will not generate an overview for that function, method or
variable of the functions and methods that call / use it.
The overview will not be generated regardless of the value of
\ref cfg_referenced_by_relation "REFERENCED_BY_RELATION".
\note The completeness (and correctness) of the overview depends on the
doxygen code parser which is not perfect.
\sa section \ref cmdshowrefs "\\showrefs",
section \ref cmdshowrefby "\\showrefby",
section \ref cmdhiderefs "\\hiderefs" and
option \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION"
<hr>
\section cmdshowrefs \\showrefs
\addindex \\showrefs
When this command is put in a comment block of a function or method,
then doxygen will generate an overview for that function or method of the
functions and methods that call it.
The overview will be generated regardless of the value of
\ref cfg_references_relation "REFERENCES_RELATION".
\note The completeness (and correctness) of the overview depends on the
doxygen code parser which is not perfect.
\sa section \ref cmdshowrefby "\\showrefby",
section \ref cmdhiderefby "\\hiderefby",
section \ref cmdhiderefs "\\hiderefs" and
option \ref cfg_references_relation "REFERENCES_RELATION"
<hr>
\section cmdhiderefs \\hiderefs
\addindex \\hiderefs
When this command is put in a comment block of a function or method
and then doxygen will not generate an overview for that function or method of
the functions and methods that call it.
The overview will not be generated regardless of the value of
\ref cfg_references_relation "REFERENCES_RELATION".
\note The completeness (and correctness) of the overview depends on the
doxygen code parser which is not perfect.
\sa section \ref cmdshowrefs "\\showrefs",
section \ref cmdshowrefby "\\showrefby",
section \ref cmdhiderefby "\\hiderefby" and
option \ref cfg_references_relation "REFERENCES_RELATION"
<hr>
\section cmdincludegraph \\includegraph
\addindex \\includegraph
When this command is put in a comment block of a file
then doxygen will generate an include graph for that file. The
include graph will be generated regardless of the value of
\ref cfg_include_graph "INCLUDE_GRAPH".
\sa section \ref cmdhideincludegraph "\\hideincludegraph",
section \ref cmdincludedbygraph "\\includedbygraph",
section \ref cmdhideincludedbygraph "\\hideincludedbygraph" and
option \ref cfg_include_graph "INCLUDE_GRAPH"
<hr>
\section cmdhideincludegraph \\hideincludegraph
\addindex \\hideincludegraph
When this command is put in a comment block of a file
then doxygen will not generate an include graph for that file. The
include graph will not be generated regardless of the value of
\ref cfg_include_graph "INCLUDE_GRAPH".
\sa section \ref cmdincludegraph "\\includegraph",
section \ref cmdincludedbygraph "\\includedbygraph",
section \ref cmdhideincludedbygraph "\\hideincludedbygraph" and
option \ref cfg_include_graph "INCLUDE_GRAPH"
<hr>
\section cmdincludedbygraph \\includedbygraph
\addindex \\includedbygraph
When this command is put in a comment block of an include file
then doxygen will generate an included by graph for that include file. The
included by graph will be generated regardless of the value of
\ref cfg_included_by_graph "INCLUDED_BY_GRAPH".
\sa section \ref cmdhideincludedbygraph "\\hideincludedbygraph",
section \ref cmdincludegraph "\\ncludegraph",
section \ref cmdhideincludegraph "\\hideincludegraph" and
option \ref cfg_included_by_graph "INCLUDED_BY_GRAPH"
<hr>
\section cmdhideincludedbygraph \\hideincludedbygraph
\addindex \\hideincludedbygraph
When this command is put in a comment block of an include file
then doxygen will not generate an included by graph for that include file. The
included by graph will not be generated regardless of the value of
\ref cfg_included_by_graph "INCLUDED_BY_GRAPH".
\sa section \ref cmdincludedbygraph "\\includedbygraph",
section \ref cmdincludegraph "\\ncludegraph",
section \ref cmdhideincludegraph "\\hideincludegraph" and
option \ref cfg_included_by_graph "INCLUDED_BY_GRAPH"
<hr>
\section cmddirectorygraph \\directorygraph
\addindex \\directorygraph
When this command is put in a comment block of a directory
(see section \ref cmddir "\\dir")
then doxygen will generate a directory graph for that directory. The
directory graph will be generated regardless of the value of
\ref cfg_directory_graph "DIRECTORY_GRAPH".
\sa section \ref cmdhidedirectorygraph "\\hidedirectorygraph",
option \ref cfg_directory_graph "DIRECTORY_GRAPH"
<hr>
\section cmdhidedirectorygraph \\hidedirectorygraph
\addindex \\hidedirectorygraph
When this command is put in a comment block of a directory
(see section \ref cmddir "\\dir")
then doxygen will not generate a directory graph for that directory. The
directory graph will not be generated regardless of the value of
\ref cfg_directory_graph "DIRECTORY_GRAPH".
\sa section \ref cmddirectorygraph "\\directorygraph",
option \ref cfg_directory_graph "DIRECTORY_GRAPH"
<hr>
\section cmdcollaborationgraph \\collaborationgraph
\addindex \\collaborationgraph
When this command is put in a comment block of a class
then doxygen will generate a collaboration graph for that class. The
collaboration graph will be generated regardless of the value of
\ref cfg_collaboration_graph "COLLABORATION_GRAPH".
\sa section \ref cmdhidecollaborationgraph "\\hidecollaborationgraph",
option \ref cfg_collaboration_graph "COLLABORATION_GRAPH"
<hr>
\section cmdhidecollaborationgraph \\hidecollaborationgraph
\addindex \\hidecollaborationgraph
When this command is put in a comment block of a class
then doxygen will not generate a collaboration graph for that class. The
collaboration graph will not be generated regardless of the value of
\ref cfg_collaboration_graph "COLLABORATION_GRAPH".
\sa section \ref cmdcollaborationgraph "\\collaborationgraph",
option \ref cfg_collaboration_graph "COLLABORATION_GRAPH"
<hr>
\section cmdinheritancegraph \\inheritancegraph['{option}']
\addindex \\inheritancegraph
When this command is put in a comment block of a class
then doxygen will generate an inheritance graph for that class conforming the `option`.
The inheritance graph will be generated, conforming the `option`, regardless of the value of
\ref cfg_class_graph "CLASS_GRAPH".
The possible values of `option` are the same values as can be used with \ref cfg_class_graph "CLASS_GRAPH".
In case no `option` is specified the value `YES` is assumed.
\sa section \ref cmdhideinheritancegraph "\\hideinheritancegraph",
option \ref cfg_class_graph "CLASS_GRAPH"
<hr>
\section cmdhideinheritancegraph \\hideinheritancegraph
\addindex \\hideinheritancegraph
When this command is put in a comment block of a class
then doxygen will not generate an inheritance graph for that class. The
inheritance graph will not be generated regardless of the value of
\ref cfg_class_graph "CLASS_GRAPH".
\sa section \ref cmdinheritancegraph "\\inheritancegraph",
option \ref cfg_class_graph "CLASS_GRAPH"
<hr>
\section cmdgroupgraph \\groupgraph
\addindex \\groupgraph
When this command is put in a comment block of a
\ref cmddefgroup "\\defgroup" command
then doxygen will generate a group dependency graph for that group. The
group graph will be generated regardless of the value of
\ref cfg_group_graphs "GROUP_GRAPHS".
\sa section \ref cmdhidegroupgraph "\\hidegroupgraph",
option \ref cfg_group_graphs "GROUP_GRAPHS"
<hr>
\section cmdhidegroupgraph \\hidegroupgraph
\addindex \\hidegroupgraph
When this command is put in a comment block of a
\ref cmddefgroup "\\defgroup" command
then doxygen will not generate a group dependency graph for that group. The
group graph will not be generated regardless of the value of
\ref cfg_group_graphs "GROUP_GRAPHS".
\sa section \ref cmdgroupgraph "\\groupgraph",
option \ref cfg_group_graphs "GROUP_GRAPHS"
<hr>
\section cmdqualifier \\qualifier <label> | "(text)"
\addindex \\qualifier
With this command it is possible to add custom qualifier labels
to members and classes. These labels will be shown in the output in the same way
as the automatically generated labels such as "static", "inline", and "final".
For instance to indicate that a function is only meant for testing purposes
one could add `\qualifier test`
<hr>
\section cmdcategory \\category <name> [<header-file>] [<header-name>]
\addindex \\category
For Objective-C only: Indicates that a comment block contains documentation
for a class category with name \<name\>. The arguments are
equal to the \ref cmdclass "\\class" command.
\sa section \ref cmdclass "\\class".
<hr>
\section cmdclass \\class <name> [<header-file>] [<header-name>]
\addindex \\class
Indicates that a comment block contains documentation for a
class with name \<name\>. Optionally a header file and a header name
can be specified. If the header-file is specified, a link to a verbatim copy
of the header will be included in the HTML documentation.
The \<header-name\> argument can be used to overwrite the
name of the link that is used in the class documentation to something other
than \<header-file\>. This can be useful if the include name is not located
on the default include path (like \<X11/X.h\>). With the \<header-name\>
argument you can also specify how the include statement should look like,
by adding either quotes or sharp brackets around the name.
Sharp brackets are used if just the name is given. Note that the
last two arguments can also be specified using
the \ref cmdheaderfile "\\headerfile" command.
\par Example:
\include class.h
\htmlonly
Click <a href="examples/class/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
\latexonly
See \hyperlink{class_example}{Class example}
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
<hr>
\section cmdconcept \\concept <name>
\addindex \\concept
Indicates that a comment block contains documentation for a
C++20 concept with name \<name\>.
See also the \ref cmdheaderfile "\\headerfile" command to specify the
header a user should be included to use the concept.
<hr>
\section cmddef \\def <name>
\addindex \\def
Indicates that a comment block contains documentation for a
\c \#define macro.
\par Example:
\include define.h
\htmlonly
Click <a href="examples/define/html/define_8h.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
\latexonly
See \hyperlink{define_8h}{Define example}
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
<hr>
\section cmddefgroup \\defgroup <name> (group title)
\addindex \\defgroup
Indicates that a comment block contains documentation for a
\ref topics "topics" of classes, modules, concepts, files or namespaces. This can be used to
categorize symbols, and document those categories.
You can also use groups as members of other groups,
thus building a hierarchy of groups.
The \<name\> argument should be a single-word identifier.
\sa page \ref grouping "Grouping", sections \ref cmdingroup "\\ingroup", \ref cmdaddtogroup "\\addtogroup", and
\ref cmdweakgroup "\\weakgroup".
<hr>
\section cmddir \\dir [<path fragment>]
\addindex \\dir
Indicates that a comment block contains documentation for a directory.
The "path fragment" argument should include the directory name and
enough of the path to be unique with respect to the other directories
in the project.
The \ref cfg_strip_from_path "STRIP_FROM_PATH" option determines what is
stripped from the full path before it appears in the output.
<hr>
\section cmdenum \\enum <name>
\addindex \\enum
Indicates that a comment block contains documentation for an
enumeration, with name \<name\>. If the enum is a member of a class and
the documentation block is located outside the class definition,
the scope of the class should be specified as well.
If a comment block is located directly in front of an enum declaration,
the \c \\enum comment may be omitted.
\par Note:
The type of an anonymous enum cannot be documented, but the values
of an anonymous enum can.
\par Example:
\include enum.h
\htmlonly
Click <a href="examples/enum/html/class_enum___test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
\latexonly
See \hyperlink{class_enum___test}{Enum example}
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
<hr>
\section cmdexample \\example['{lineno}'] <file-name>
\addindex \\example
Indicates that a comment block contains documentation for a source code
example. The name of the source file is \<file-name\>.
The contents of this file will be included in the documentation, just after the
documentation contained in the comment block.
You can add option `{lineno}` to enable line numbers for the example if desired.
All examples are placed in a list. The source code is scanned for documented members and classes.
If any are found, the names are cross-referenced with the documentation.
Source files or directories can be specified using the
\ref cfg_example_path "EXAMPLE_PATH"
tag of doxygen's configuration file.
If \<file-name\> itself is not unique for the set of example files specified
by the
\ref cfg_example_path "EXAMPLE_PATH" tag, you can include part of the absolute path
to disambiguate it.
If more than one source file is needed for the example,
the \ref cmdinclude "\\include" command can be used.
\par Example:
\include example.cpp
Where the example file \c example_test.cpp looks as follows:
\include example_test.cpp
\htmlonly
Click <a href="examples/example/html/examples.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
\latexonly
See \hyperlink{example_test_8cpp-example}{Example example}
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
\sa section \ref cmdinclude "\\include".
<hr>
\section cmdendinternal \\endinternal
\addindex \\endinternal
This command ends a documentation fragment that was started with a
\ref cmdinternal "\\internal" command. The text between \ref cmdinternal "\\internal" and
\c \\endinternal will only be visible
if \ref cfg_internal_docs "INTERNAL_DOCS" is set to \c YES.
<hr>
\section cmdextends \\extends <name>
\addindex \\extends
This command can be used to manually indicate an inheritance relation,
when the programming language does not support this concept natively
(e.g. C).
The file \c manual.c in the example directory shows how to use this command
(see also \ref cmdmemberof "\\memberof" for the complete file).
\htmlonly
Click <a href="examples/manual/html/struct_car.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
\latexonly
See \hyperlink{extends_example}{Extends example}
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
\sa section \ref cmdimplements "\\implements" and section
\ref cmdmemberof "\\memberof"
<hr>
\section cmdfile \\file [<name>]
\addindex \\file
Indicates that a comment block contains documentation for a source or
header file with name \<name\>. The file name may include (part of) the
path if the file-name alone is not unique. If the file name is omitted
(i.e. the line after \c \\file is left blank) then the documentation block that
contains the \c \\file command will belong to the file it is located in.
\par Important:
The documentation of global functions, variables, typedefs, and enums will
only be included in the output if the file they are in is documented as well
or if \ref cfg_extract_all "EXTRACT_ALL" is set to \c YES.
\par Example:
\include file.h
\htmlonly
Click <a href="examples/file/html/file_8h.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
\latexonly
See \hyperlink{file_example}{File example}
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
\note In the above example \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF"
has been set to \c YES in the configuration file.
<hr>
\section cmdfileinfo \\fileinfo['{'option'}']
\addindex \\fileinfo
Shows (part) of the file name in which this command is placed.
The `option` can be `name`, `extension`, `filename`, `directory` or, `full`,
with
- `name` the name of the file without extension
- `extension` the extension of the file
- `filename` the filename i.e. `name` plus `extension`
- `directory` the directory of the given file
- `full` the full path and filename of the given file.
In case no option is specified the `filename` is used unless
\ref cfg_full_path_names "FULL_PATH_NAMES" is set to `YES` in which case `full` is used.
\note the command \\fileinfo cannot be used as argument to the \ref cmdfile "\\file" command
\see section \ref cmdlineinfo "\\lineinfo"
<hr>
\section cmdlineinfo \\lineinfo
\addindex \\lineinfo
Shows the line number inside the file at which this command is placed.
\see section \ref cmdfileinfo "\\fileinfo"
<hr>
\section cmdfn \\fn (function declaration)
\addindex \\fn
Indicates that a comment block contains documentation for a function
(either global or as a member of a class). This command is \em only
needed if a comment block is \e not placed in front (or behind)
the function declaration or definition.
If your comment block \e is in front of the function
declaration or definition this command can (and to avoid redundancy
should) be omitted.
A full function declaration including arguments should be specified after the
\c \\fn command on a \e single line, since the argument ends at the end
of the line!
This command is equivalent to \ref cmdvar "\\var", \ref cmdtypedef "\\typedef",
and \ref cmdproperty "\\property".
\warning Do not use this command
if it is not absolutely needed, since it will lead to duplication of
information and thus to errors.
\par Example:
\include func.h
\htmlonly
Click <a href="examples/func/html/class_fn___test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
\latexonly
See \hyperlink{class_fn___test}{Fn example}
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
\sa sections \ref cmdvar "\\var", \ref cmdproperty "\\property", and
\ref cmdtypedef "\\typedef".
<hr>
\section cmdheaderfile \\headerfile <header-file> [<header-name>]
\addindex \\headerfile
Intended to be used for class, struct, or union documentation, where
the documentation is in front of the definition. The arguments of
this command are the same as the second and third argument of
\ref cmdclass "\\class".
The \<header-file\> name refers to the file that should be included by the
application to obtain the definition of the class, struct, or union.
The \<header-name\> argument can be used to overwrite the
name of the link that is used in the class documentation to something other
than \<header-file\>. This can be useful if the include name is not located
on the default include path (like \<X11/X.h\>).
With the \<header-name\>
argument you can also specify how the include statement should look like,
by adding either double quotes or sharp brackets around the name.
By default sharp brackets are used if just the name is given.
If a pair of double quotes is given for either the \<header-file\> or
\<header-name\> argument, the current file (in which the command was found)
will be used but with quotes. So for a comment block with a \c \\headerfile
command inside a file <code>test.h</code>, the following three commands are equivalent:
\verbatim
\headerfile test.h "test.h"
\headerfile test.h ""
\headerfile "" \endverbatim
To get sharp brackets you do not need to specify anything,
but if you want to be explicit you could use any of the following:
\verbatim
\headerfile test.h <test.h>
\headerfile test.h <>
\headerfile <> \endverbatim
To globally reverse the default include representation to
local includes you can set
\ref cfg_force_local_includes "FORCE_LOCAL_INCLUDES" to \c YES.
To disable the include information altogether set
\ref cfg_show_headerfile "SHOW_HEADERFILE" to \c NO.
<hr>
\section cmdhideinitializer \\hideinitializer
\addindex \\hideinitializer
By default the value of a define and the initializer of a variable
are displayed unless they are longer than 30 lines. By putting
this command in a comment block of a define or variable, the
initializer is always hidden. The maximum number of initialization lines
can be changed by means of the configuration parameter
\ref cfg_max_initializer_lines "MAX_INITIALIZER_LINES", the default
value is 30.
\sa section \ref cmdshowinitializer "\\showinitializer".
<hr>
\section cmdidlexcept \\idlexcept <name>
\addindex \\idlexcept
Indicates that a comment block contains documentation for a
IDL exception with name \<name\>.
<hr>
\section cmdimplements \\implements <name>
\addindex \\implements
This command can be used to manually indicate an inheritance relation,
when the programming language does not support this concept natively
(e.g. C).
The file \c manual.c in the example directory shows how to use this command
(see also \ref cmdmemberof "\\memberof" for the complete file).
\htmlonly
Click <a href="examples/manual/html/struct_car.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
\latexonly
See \hyperlink{extends_example}{Implements example}
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
\sa section \ref cmdextends "\\extends" and section
\ref cmdmemberof "\\memberof"
<hr>
\section cmdingroup \\ingroup (<groupname> [<groupname>]*)
\addindex \\ingroup
If the \c \\ingroup command is placed in a comment block of a compound entity
(like class, file or namespace), then it will be added to the group(s)
identified by the `<groupname>`(s).
In case of members (like variable, functions, typedefs and enums) the member will
be added only to one group (to avoid ambiguous linking targets in case
a member is not documented in the context of its class, namespace
or file, but only visible as part of a group).
\sa page \ref grouping "Grouping", sections \ref cmddefgroup "\\defgroup",
\ref cmdaddtogroup "\\addtogroup", and \ref cmdweakgroup "\\weakgroup"
<hr>
\section cmdinterface \\interface <name> [<header-file>] [<header-name>]
\addindex \\interface
Indicates that a comment block contains documentation for an