summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Nikias Bassen2025-10-23 01:00:14 +0200
committerGravatar Nikias Bassen2025-10-23 01:00:14 +0200
commitd9958ba8fd366e1092f0f4d07717227689adce2b (patch)
tree87df8ceedc17afc4ef8f323be6ccb45756e76aa9
parent7355dc8e8344f00fae0e24db72e461d985eb6381 (diff)
downloadlibplist-d9958ba8fd366e1092f0f4d07717227689adce2b.tar.gz
libplist-d9958ba8fd366e1092f0f4d07717227689adce2b.tar.bz2
Update documentation style
-rw-r--r--docs/doxygen/custom.css1722
-rw-r--r--docs/doxygen/favicon.icobin0 -> 1150 bytes
-rw-r--r--docs/doxygen/folder-open.pngbin0 -> 625 bytes
-rw-r--r--docs/doxygen/folder.pngbin0 -> 498 bytes
-rw-r--r--docs/doxygen/footer.html9
-rw-r--r--docs/doxygen/header.html64
-rw-r--r--docs/doxygen/layout.xml226
-rw-r--r--docs/doxygen/logo-vector-clean.svg1
-rw-r--r--docs/doxygen/text-x-generic.pngbin0 -> 333 bytes
-rw-r--r--doxygen.cfg.in3038
10 files changed, 4268 insertions, 792 deletions
diff --git a/docs/doxygen/custom.css b/docs/doxygen/custom.css
new file mode 100644
index 0000000..62183bf
--- /dev/null
+++ b/docs/doxygen/custom.css
@@ -0,0 +1,1722 @@
1body, table, div, p, dl {
2 font: 14px -apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji;
3 line-height: 1.5;
4}
5
6/* @group Heading Levels */
7
8h1.groupheader {
9 font-size: 28px;
10}
11
12.title {
13 font: inherit;
14 font-size: 2rem;
15 font-weight: bold;
16 margin: 0;
17 padding-bottom: 0.3rem;
18 border-bottom: 1px solid #eaecef;
19}
20
21h2.groupheader {
22 border-bottom: none;
23 color: rgb(36, 41, 46);
24 font-size: 1.5rem;
25 font-weight: bold;
26 margin: 1.75rem 0px 1rem 0px;
27 padding: 0 0.3rem 0 0;
28 border-bottom: 1px solid #eaecef;
29 width: 100%;
30}
31
32h3.groupheader {
33 font-size: 100%;
34}
35
36h1, h2, h3, h4, h5, h6 {
37 -webkit-transition: text-shadow 0.5s linear;
38 -moz-transition: text-shadow 0.5s linear;
39 -ms-transition: text-shadow 0.5s linear;
40 -o-transition: text-shadow 0.5s linear;
41 transition: text-shadow 0.5s linear;
42}
43
44.textblock h1,
45.textblock h2,
46.textblock h3,
47.textblock h4,
48.textblock h5,
49.textblock h6 {
50 margin: 1.75rem 0px 1rem 0px;
51 padding: 0 0.3rem 0 0;
52 border-bottom: 1px solid #eaecef;
53}
54
55h1 {
56 font-size: 1.75rem;
57}
58
59h2 {
60 color: rgb(36, 41, 46);
61 font-size: 1.5rem;
62 font-weight: bold;
63 margin: 1.75rem 0 1rem 0px;
64}
65
66h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
67 text-shadow: 0 0 15px #1fa4a9;
68}
69
70dt {
71 font-weight: bold;
72}
73
74div.multicol {
75 -moz-column-gap: 1em;
76 -webkit-column-gap: 1em;
77 -moz-column-count: 3;
78 -webkit-column-count: 3;
79}
80
81p.startli, p.startdd, p.starttd {
82 margin-top: 2px;
83}
84
85p.endli {
86 margin-bottom: 0px;
87}
88
89p.enddd {
90 margin-bottom: 4px;
91}
92
93p.endtd {
94 margin-bottom: 2px;
95}
96
97/* @end */
98
99caption {
100 font-weight: bold;
101}
102
103span.legend {
104 font-size: 70%;
105 text-align: center;
106}
107
108h3.version {
109 font-size: 90%;
110 text-align: center;
111}
112
113div.qindex, div.navtab {
114 background-color: #fff;
115 border: 1px solid #d1d5da;
116 padding: 0;
117 border-radius: 3px;
118 text-align: left;
119}
120
121div.qindex, div.navpath {
122 width: auto;
123 line-height: 140%;
124}
125
126div.navtab {
127 margin-right: 2rem;
128}
129
130@media (max-width: 576px) {
131 .contents td.top:not(.mempage),
132 div.navtab {
133 display: none;
134 }
135}
136
137div.navtab table {
138 border-spacing: 0;
139}
140
141div.navtab table td.navtab {
142 position: relative;
143 display: block;
144 padding: 8px 10px;
145 border-bottom: 1px solid #e1e4e8;
146}
147
148div.navtab table td.navtab:hover {
149 background-color: #f6f8fa;
150}
151
152/* @group Link Styling */
153
154a {
155 color: #005082;
156 font-weight: normal;
157 text-decoration: none;
158}
159
160.contents a:visited {
161 color: #005082;
162}
163
164a:hover {
165 text-decoration: underline;
166}
167
168a.qindex {
169 font-weight: bold;
170}
171
172a.qindexHL {
173 font-weight: bold;
174 background-color: #fff;
175 color: inherit;
176 border: none;
177}
178
179a.qindexHL:before {
180 position: absolute;
181 top: 0;
182 bottom: 0;
183 left: 0;
184 width: 2px;
185 content: "";
186 background-color: #f7ae1a;
187}
188
189.contents a.qindexHL:visited {
190 color: inherit;
191}
192
193a.el {
194 font-weight: normal;
195}
196
197a.elRef {
198}
199
200a.code, a.code:visited {
201 color: #3465a4;
202}
203
204a.codeRef, a.codeRef:visited {
205 color: #3465a4;
206}
207
208/* @end */
209
210dl.el {
211 margin-left: -1cm;
212}
213
214pre.fragment {
215 border: 1px solid rgb(221, 221, 221);
216 border-radius: 3px;
217 background-color: rgb(248, 248, 248);
218 padding: 1rem;
219 margin: 1rem 0px;
220 overflow: auto;
221 word-wrap: break-word;
222 font-size: inherit;
223 line-height: inherit;
224 font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;
225}
226
227div.fragment {
228 padding: 1rem;
229 margin: 1rem 0px;
230 border: solid 1px rgb(221, 221, 221);
231 border-radius: 3px;
232 background-color: rgb(248, 248, 248);
233}
234
235div.line {
236 font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;
237 font-size: inherit;
238 min-height: 1rem;
239 line-height: inherit;
240 text-wrap: unrestricted;
241 white-space: -moz-pre-wrap; /* Moz */
242 white-space: -pre-wrap; /* Opera 4-6 */
243 white-space: -o-pre-wrap; /* Opera 7 */
244 white-space: pre-wrap; /* CSS3 */
245 word-wrap: break-word; /* IE 5.5+ */
246 text-indent: initial;
247 padding-left: initial;
248 padding-bottom: 0px;
249 margin: 0px;
250 -webkit-transition-property: background-color, box-shadow;
251 -webkit-transition-duration: 0.5s;
252 -moz-transition-property: background-color, box-shadow;
253 -moz-transition-duration: 0.5s;
254 -ms-transition-property: background-color, box-shadow;
255 -ms-transition-duration: 0.5s;
256 -o-transition-property: background-color, box-shadow;
257 -o-transition-duration: 0.5s;
258 transition-property: background-color, box-shadow;
259 transition-duration: 0.5s;
260 display: inline-block;
261 min-width: 100%;
262}
263
264div.line.glow {
265 background-color: cyan;
266 box-shadow: 0 0 10px cyan;
267}
268
269
270span.lineno {
271 padding-right: 4px;
272 text-align: right;
273 border-right: 2px solid #0F0;
274 background-color: #E8E8E8;
275 white-space: pre;
276}
277span.lineno a {
278 background-color: #D8D8D8;
279}
280
281span.lineno a:hover {
282 background-color: #C8C8C8;
283}
284
285div.ah {
286 background-color: black;
287 font-weight: bold;
288 color: #ffffff;
289 margin-bottom: 3px;
290 margin-top: 3px;
291 padding: 0.2em;
292 border: solid thin #333;
293 border-radius: 0.5em;
294 -webkit-border-radius: .5em;
295 -moz-border-radius: .5em;
296 box-shadow: 2px 2px 3px #999;
297 -webkit-box-shadow: 2px 2px 3px #999;
298 -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
299 background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
300 background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000);
301}
302
303div.groupHeader {
304 margin-left: 0px;
305 margin-top: 9px;
306 margin-bottom: 4.7px;
307
308 font-size: 19px;
309 font-weight: normal;
310}
311
312div.groupText {
313 margin-left: 16px;
314 font-style: italic;
315}
316
317body {
318 background-color: white;
319 color: rgb(36, 41, 46);
320 margin: 0;
321}
322
323div.contents {
324 padding: 1rem 2rem;
325 margin: 0;
326}
327
328td.indexkey {
329 background-color: #EBEFF6;
330 font-weight: bold;
331 border: 1px solid #C4CFE5;
332 margin: 2px 0px 2px 0;
333 padding: 2px 10px;
334 white-space: nowrap;
335 vertical-align: top;
336}
337
338td.indexvalue {
339 background-color: #EBEFF6;
340 border: 1px solid #C4CFE5;
341 padding: 2px 10px;
342 margin: 2px 0px;
343}
344
345tr.memlist {
346 background-color: #EEF1F7;
347}
348
349p.formulaDsp {
350 text-align: center;
351}
352
353img.formulaDsp {
354}
355
356img.formulaInl {
357 vertical-align: middle;
358}
359
360div.center {
361 text-align: center;
362 margin-top: 0px;
363 margin-bottom: 0px;
364 padding: 0px;
365}
366
367div.center img {
368 border: 0px;
369}
370
371address.footer {
372 text-align: left;
373 margin-left: 2rem;
374 margin-right: 2rem;
375 margin-bottom: 1rem;
376}
377
378img.footer {
379 border: 0px;
380 vertical-align: middle;
381}
382
383/* @group Code Colorization */
384
385span.keyword {
386 color: #008000;
387}
388
389span.keywordtype {
390 color: #604020;
391}
392
393span.keywordflow {
394 color: #e08000;
395}
396
397span.comment {
398 color: #800000;
399}
400
401span.preprocessor {
402 color: #806020;
403}
404
405span.stringliteral {
406 color: #002080;
407}
408
409span.charliteral {
410 color: #008080;
411}
412
413span.vhdldigit {
414 color: #ff00ff;
415}
416
417span.vhdlchar {
418 color: #000000;
419}
420
421span.vhdlkeyword {
422 color: #700070;
423}
424
425span.vhdllogic {
426 color: #ff0000;
427}
428
429blockquote {
430 background-color: #F7F8FB;
431 border-left: 2px solid #9CAFD4;
432 margin: 0 24px 0 4px;
433 padding: 0 12px 0 16px;
434}
435
436/* @end */
437
438td.tiny {
439 font-size: 75%;
440}
441
442.dirtab {
443 padding: 4px;
444 border-collapse: collapse;
445 border: 1px solid #A3B4D7;
446}
447
448th.dirtab {
449 background: #EBEFF6;
450 font-weight: bold;
451}
452
453hr {
454 height: 0px;
455 border: none;
456 border-top: 1px solid #e1e4e8;
457}
458
459hr.footer {
460 height: 0px;
461 border-top: 1px solid #e1e4e8;
462 margin-left: 2rem;
463 margin-right: 2rem;
464}
465
466/* @group Member Descriptions */
467
468table.memberdecls {
469 border-spacing: inherit;
470 padding: 0px;
471 background-color: transparent;
472 border-color: #c8e1ff;
473}
474
475table.memberdecls tr:not(.heading) {
476 background-color: #f1f8ff;
477}
478
479table.memberdecls tr:not(.heading) td.ititle {
480 background-color: #fff;
481 border: none;
482}
483
484.memberdecls td, .fieldtable tr {
485 -webkit-transition-property: background-color, box-shadow;
486 -webkit-transition-duration: 0.5s;
487 -moz-transition-property: background-color, box-shadow;
488 -moz-transition-duration: 0.5s;
489 -ms-transition-property: background-color, box-shadow;
490 -ms-transition-duration: 0.5s;
491 -o-transition-property: background-color, box-shadow;
492 -o-transition-duration: 0.5s;
493 transition-property: background-color, box-shadow;
494 transition-duration: 0.5s;
495}
496
497.memberdecls td.glow, .fieldtable tr.glow {
498 background-color: #1fa4a9;
499 box-shadow: none;
500}
501
502.mdescLeft, .mdescRight,
503.memItemLeft, .memItemRight,
504.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
505 background-color: transparent;
506 border: none;
507 margin: 0;
508 padding: 1rem 1rem 0.5rem 1rem;
509 font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;
510}
511
512.mdescLeft,
513.memItemLeft,
514.memTemplItemLeft {
515 border-left: 1px solid #c8e1ff;
516}
517
518.mdescRight,
519.memItemRight,
520.memTemplItemRight {
521 border-right: 1px solid #c8e1ff;
522}
523
524.memberdecls tr:nth-child(2) td {
525 border-top: 1px solid #c8e1ff;
526 padding-bottom: 1rem;
527}
528
529.memberdecls tr:last-child td {
530 border-bottom: none;
531 padding-bottom: 1rem;
532}
533
534.memberdecls tr:nth-last-child(2) td {
535 padding-bottom: 1rem;
536}
537
538.mdescLeft, .mdescRight {
539 padding: 0 1rem 1rem 1rem;
540 color: black;
541
542 /* font-family: "Lucida Grande", "Lucida Sans Unicode", Helvetica, Arial, Verdana, sans-serif; */
543 font-style: normal;
544}
545
546.memSeparator {
547 background-color: #fff;
548 border-top: 1px solid #c8e1ff;
549 border-bottom: 1px solid #c8e1ff;
550 line-height: 0.5rem;
551 margin: 0px;
552 padding: 0px;
553}
554
555tr:last-child .memSeparator {
556 border-bottom: none;
557}
558
559.memItemLeft, .memTemplItemLeft {
560 white-space: nowrap;
561}
562
563.memItemRight {
564 width: 100%;
565}
566
567.mdescRight a.el:first-child,
568.memItemRight a.el:first-child,
569.memTemplItemRight a.el:first-child {
570 font-weight: bold;
571}
572
573.memTemplParams {
574 color: #005082;
575 white-space: nowrap;
576 font-size: 80%;
577}
578
579/* @end */
580
581/* @group Member Details */
582
583/* Styles for detailed member documentation */
584
585.memtitle {
586 padding: 0 0.3rem 0 0;
587 border: none;
588 border-bottom: 1px solid #eaecef;
589 margin: 0 0 1.75rem 0;
590 line-height: inherit;
591 background: none;
592 font-weight: bold;
593 font-size: 2rem;
594 width: 100%;
595 float: left;
596}
597
598.permalink {
599 font-size: 65%;
600 display: inline-block;
601 vertical-align: middle;
602 display: none;
603}
604
605.permalink a:hover {
606 text-decoration: none;
607}
608
609.memtemplate {
610 font-size: 100%;
611 color: black;
612 font-weight: normal;
613 margin-left: 1px;
614}
615
616.memnav {
617 background-color: #EBEFF6;
618 border: 1px solid #A3B4D7;
619 text-align: center;
620 margin: 2px;
621 margin-right: 15px;
622 padding: 2px;
623}
624
625.mempage {
626 width: 100%;
627}
628
629.memitem {
630 padding: 0;
631 margin-bottom: 2rem;
632 margin-right: 0;
633 -webkit-transition: box-shadow 0.5s linear;
634 -moz-transition: box-shadow 0.5s linear;
635 -ms-transition: box-shadow 0.5s linear;
636 -o-transition: box-shadow 0.5s linear;
637 transition: box-shadow 0.5s linear;
638 display: table !important;
639 width: 100%;
640 background-color: #f1f8ff;
641 border-color: #c8e1ff;
642}
643
644.memitem.glow {
645 box-shadow: 0 0 15px #1fa4a9;
646}
647
648.memname {
649 font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;
650 margin-left: 0px;
651 border-spacing: initial;
652}
653
654.memname td {
655 font-weight: bold;
656 vertical-align: bottom;
657}
658
659.memproto, dl.reflist dt {
660 border: none;
661 border: 1px solid #c8e1ff;
662 padding: 1rem;
663 color: black;
664 font-weight: bold;
665 text-shadow: none;
666 background-image: none;
667 background-color: #f1f8ff;
668 /* opera specific markup */
669 box-shadow: none;
670 border-top-right-radius: 0px;
671 border-top-left-radius: 0px;
672 /* firefox specific markup */
673 -moz-box-shadow: none;
674 -moz-border-radius-topright: 0px;
675 -moz-border-radius-topleft: 0px;
676 /* webkit specific markup */
677 -webkit-box-shadow: none;
678 -webkit-border-top-right-radius: 0px;
679 -webkit-border-top-left-radius: 0px;
680}
681
682.memdoc, dl.reflist dd {
683 border: none;
684 padding: 6px;
685 background-color: #FBFCFD;
686 border-top-width: 0;
687 background-image: none;
688 background-color: #FFFFFF;
689 /* opera specific markup */
690 border-bottom-left-radius: 0px;
691 border-bottom-right-radius: 0px;
692 box-shadow: none;
693 /* firefox specific markup */
694 -moz-border-radius-bottomleft: 0px;
695 -moz-border-radius-bottomright: 0px;
696 -moz-box-shadow: none;
697 /* webkit specific markup */
698 -webkit-border-bottom-left-radius: 0px;
699 -webkit-border-bottom-right-radius: 0px;
700 -webkit-box-shadow: none;
701}
702
703dl.reflist dt {
704 padding: 5px;
705}
706
707dl.reflist dd {
708 margin: 0px 0px 10px 0px;
709 padding: 5px;
710}
711
712.paramkey {
713 text-align: right;
714}
715
716.paramtype {
717 white-space: nowrap;
718}
719
720.paramname {
721 color: #01496d;
722 white-space: nowrap;
723}
724.paramname em {
725 font-style: italic;
726 font-weight: normal;
727}
728.paramname code {
729 line-height: 14px;
730}
731
732.params, .retval, .exception, .tparams {
733 margin-left: 0px;
734 padding-left: 0px;
735}
736
737.params .paramname, .retval .paramname {
738 font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;
739 font-style: italic;
740 font-weight: normal;
741 text-shadow: none;
742 padding-right: 1rem;
743}
744
745.params .paramtype {
746 font-style: italic;
747 vertical-align: top;
748}
749
750.params .paramdir {
751 font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;
752 vertical-align: top;
753}
754
755table.mlabels {
756 border-spacing: 0px;
757}
758
759td.mlabels-left {
760 width: 100%;
761 padding: 0px;
762}
763
764td.mlabels-right {
765 vertical-align: middle;
766 padding: 0px;
767 white-space: nowrap;
768}
769
770span.mlabels {
771 margin-left: 8px;
772}
773
774span.mlabel {
775 background-color: rgb(172, 172, 172);;
776 border: none;
777 text-shadow: none;
778 color: white;
779 margin-right: 4px;
780 padding: 2px 3px;
781 border-radius: 4px;
782 font-size: 9pt;
783 white-space: nowrap;
784 vertical-align: middle;
785}
786
787/* @end */
788
789/* these are for tree view when not used as main index */
790
791div.directory {
792 border-top: 1px solid #eaecef;
793 border-left: 1px solid #eaecef;
794 border-right: 1px solid #eaecef;
795 border-bottom: 1px solid #eaecef;
796 margin: 10px 0px;
797 width: 100%;
798}
799
800.directory table {
801 border-collapse:collapse;
802}
803
804.directory td {
805 margin: 0px;
806 padding: 8px;
807 vertical-align: middle;
808 line-height: 1.5rem;
809}
810
811.directory tr {
812 border-top: 1px solid #eaecef;
813}
814
815.directory tr:first-child {
816 border-top: none;
817}
818
819.directory td.entry {
820 white-space: nowrap;
821 padding: 8px;
822}
823
824@media (max-width: 576px) {
825 .directory td.entry > span:first-child {
826 display: none !important;
827 }
828}
829
830.directory td.entry a {
831 outline: none;
832}
833
834.directory td.entry a img {
835 border: none;
836}
837
838.directory td.desc {
839 width: 100%;
840 padding: 8px;
841 border-left: 1px solid rgba(0,0,0,0.05);
842}
843
844.directory tr.even {
845 padding-left: 0;
846 background-color: inherit;
847}
848
849.directory tr:not(.even) {
850 background-color: #f6f8fa;
851}
852
853.directory img {
854 vertical-align: -30%;
855}
856
857.directory .levels {
858 display: none;
859 white-space: nowrap;
860 width: auto;
861 text-align: right;
862 font-size: 0.75rem;
863 font-weight: bold;
864 padding: 8px;
865 border-bottom: 1px solid #eaecef;
866}
867
868.directory .levels span {
869 cursor: pointer;
870 padding: 0 0.5rem;
871 color: #3d578c;
872}
873
874.arrow {
875 color: #6c757d;
876 -webkit-user-select: none;
877 -khtml-user-select: none;
878 -moz-user-select: none;
879 -ms-user-select: none;
880 user-select: none;
881 cursor: pointer;
882 font-size: inherit;
883 display: inline-block;
884 width: 16px;
885 height: 16px;
886}
887
888.icon {
889 display: inline-block;
890 margin: 0;
891
892 font-family: Arial, Helvetica;
893 font-weight: bold;
894 font-size: 0.75rem;
895 text-align: center;
896
897 width: 16px;
898 height: 16px;
899 line-height: 16px;
900
901 border-radius: 4px;
902 background-color: #6194cb;
903 color: white;
904}
905
906.icona {
907 width: 16px;
908 height: 16px;
909 display: inline-block;
910 margin-left: 0.25rem;
911 margin-right: 0.25rem;
912}
913
914.iconfopen {
915 width: 16px;
916 height: 16px;
917 margin-bottom: 0;
918 background-image:url('folder-open.png');
919 background-position: 0px -1px;
920 background-repeat: no-repeat;
921 vertical-align: middle;
922 display: inline-block;
923 margin-left: 0.25rem;
924 margin-right: 0.25rem;
925}
926
927.iconfclosed {
928 width: 16px;
929 height: 16px;
930 margin-bottom: 0;
931 background-image:url('folder.png');
932 background-position: 0px 0px;
933 background-repeat: no-repeat;
934 vertical-align: middle;
935 display: inline-block;
936 margin-left: 0.25rem;
937 margin-right: 0.25rem;
938}
939
940.icondoc {
941 width: 16px;
942 height: 16px;
943 margin-bottom: 0;
944 background-image:url('text-x-generic.png');
945 background-position: 0px 0px;
946 background-repeat: no-repeat;
947 vertical-align: middle;
948 display: inline-block;
949 margin-left: 0.25rem;
950 margin-right: 0.25rem;
951}
952
953/* @end */
954
955div.dynheader {
956 margin-top: 8px;
957 -webkit-touch-callout: none;
958 -webkit-user-select: none;
959 -khtml-user-select: none;
960 -moz-user-select: none;
961 -ms-user-select: none;
962 user-select: none;
963}
964
965address {
966 font-style: normal;
967 color: #2A3D61;
968}
969
970table.doxtable {
971 border-collapse:collapse;
972 margin-top: 4px;
973 margin-bottom: 4px;
974}
975
976table.doxtable td, table.doxtable th {
977 border: 1px solid #2D4068;
978 padding: 3px 7px 2px;
979}
980
981table.doxtable th {
982 background-color: #374F7F;
983 color: #FFFFFF;
984 font-size: 110%;
985 padding-bottom: 4px;
986 padding-top: 5px;
987}
988
989table.fieldtable {
990 margin-bottom: 10px;
991 border: 1px solid #c6cbd1;
992 border-spacing: 0px;
993 -moz-border-radius: 3px;
994 -webkit-border-radius: 3px;
995 border-radius: 3px;
996 -moz-box-shadow: none;
997 -webkit-box-shadow: none;
998 box-shadow: none;
999 font-size: 1rem;
1000}
1001
1002.fieldtable td, .fieldtable th {
1003 padding: 0.5rem 1rem;
1004}
1005
1006.fieldtable td.fieldtype, .fieldtable td.fieldname {
1007 white-space: nowrap;
1008 border-right: 1px solid #c6cbd1;
1009 border-bottom: 1px solid #c6cbd1;
1010 vertical-align: middle;
1011}
1012
1013.fieldtable td.fieldname {
1014 padding-top: 0.5rem;
1015 font-style: italic;
1016}
1017
1018.fieldtable td.fielddoc {
1019 border-bottom: 1px solid #c6cbd1;
1020}
1021
1022.fieldtable td.fielddoc p {
1023 font-size: 1rem;
1024}
1025
1026.fieldtable td.fielddoc p:first-child {
1027 margin-top: 0px;
1028}
1029
1030.fieldtable td.fielddoc p:last-child {
1031 margin-bottom: 2px;
1032}
1033
1034.fieldtable tr:last-child td {
1035 border-bottom: none;
1036}
1037
1038.fieldtable tbody tr:nth-of-type(odd) {
1039 background-color: #f6f8fa;
1040}
1041
1042.fieldtable th {
1043 background-image: none;
1044 background-repeat:repeat-x;
1045 background-color: #fff;
1046 font-size: inherit;
1047 font-weight: bold;
1048 color: inherit;
1049 padding: 0.5rem 1rem;
1050 text-align: inherit;
1051 -moz-border-radius-topleft: 3px;
1052 -moz-border-radius-topright: 3px;
1053 -webkit-border-top-left-radius: 3px;
1054 -webkit-border-top-right-radius: 3px;
1055 border-top-left-radius: 3px;
1056 border-top-right-radius: 3px;
1057 border-bottom: 1px solid #c6cbd1;
1058}
1059
1060
1061.tabsearch {
1062 top: 0px;
1063 left: 10px;
1064 height: 36px;
1065 background-image: none;
1066 z-index: 101;
1067 overflow: hidden;
1068 font-size: 13px;
1069}
1070
1071.navpath ul {
1072 font-size: 1rem;
1073 background-image: none;
1074 background-repeat: repeat-x;
1075 background-position: 0 -5px;
1076 height:30px;
1077 line-height:30px;
1078 color: inherit;
1079 border: none;
1080 overflow:hidden;
1081 margin:0px;
1082 padding: 0px;
1083}
1084
1085.navpath li {
1086 list-style-type: none;
1087 float: left;
1088 background-image: none;
1089 background-repeat: no-repeat;
1090 background-position: right;
1091 color: inherit;
1092}
1093
1094#top .navpath li+li {
1095 padding-left: .5rem;
1096}
1097
1098#top .navpath li+li::before {
1099 display: inline-block;
1100 padding-right: .5rem;
1101 color: #6c757d;
1102 content: "/";
1103}
1104
1105@media (min-width: 576px) {
1106 address.footer .navpath li+li {
1107 padding-left: .5rem;
1108 }
1109
1110 address.footer .navpath li+li::before {
1111 display: inline-block;
1112 padding-right: .5rem;
1113 color: #6c757d;
1114 content: "/";
1115 }
1116}
1117
1118.navpath li.navelem a {
1119 height:32px;
1120 display: inline-block;
1121 text-decoration: none;
1122 outline: none;
1123 color: inherit;
1124 font-family: inherit;
1125 text-shadow: none;
1126 text-decoration: none;
1127}
1128
1129.navpath li.navelem a:hover {
1130 color: inherit;
1131}
1132
1133address.footer {
1134 text-align: left;
1135 padding-right: 0;
1136}
1137
1138address.footer ul.navpath {
1139 display: inline-block;
1140 padding: 0;
1141}
1142
1143.navpath li.footer {
1144 list-style-type: none;
1145 float: left;
1146 padding-left: 0.5rem;
1147 padding-right: 0;
1148 background-image: none;
1149 background-repeat: no-repeat;
1150 background-position: right;
1151 color: inherit;
1152 font-size: 0.75rem;
1153}
1154
1155div.summary {
1156 float: none;
1157 font-size: 0.75rem;
1158 padding-right: 5px;
1159 width: 100%;
1160 text-align: left;
1161}
1162
1163div.summary a {
1164 white-space: nowrap;
1165}
1166
1167div.ingroups {
1168 font-size: 0.75rem;
1169 width: 50%;
1170 text-align: left;
1171}
1172
1173div.ingroups a {
1174 white-space: nowrap;
1175}
1176
1177div.header {
1178 background-image: none;
1179 background-color: white;
1180 padding: 1rem 2rem 0 2rem;
1181 margin: 0px;
1182 border: none;
1183}
1184
1185div.headertitle {
1186 margin: 1rem 0px 0rem 0px;
1187 padding: 0 0.3rem 0 0;
1188}
1189
1190dl {
1191 padding: 0 0 0 10px;
1192}
1193
1194/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */
1195dl.section {
1196 margin-left: 0px;
1197 padding-left: 0px;
1198}
1199
1200dl.note {
1201 margin-left: 0px;
1202 padding: 1rem;
1203 border-left: 6px solid;
1204 border: 1px solid rgba(27,31,35,.15);
1205 background-color: #fffbdd;
1206 color: #735c0f;
1207}
1208
1209dl.section.note dd {
1210 margin-left: 0;
1211 margin-bottom: 0;
1212}
1213
1214dl.warning, dl.attention {
1215 margin-left: 0px;
1216 padding: 1rem;
1217
1218 border-left: 6px solid;
1219 border-color: #ab2333;
1220}
1221
1222dl.pre, dl.post, dl.invariant {
1223 margin-left:-7px;
1224 padding-left: 3px;
1225 border-left:4px solid;
1226 border-color: #4e9a06;
1227}
1228
1229dl.deprecated {
1230 margin-left: 0px;
1231 padding: 1rem;
1232 border-left: 6px solid;
1233 border-color: #505050;
1234}
1235
1236dl.deprecated dt a.el {
1237}
1238
1239dl.todo {
1240 margin-left: 0px;
1241 padding: 1rem;
1242 border-left:4px solid;
1243 border-color: #04898e;
1244}
1245
1246dl.test {
1247 margin-left:-7px;
1248 padding-left: 3px;
1249 border-left:4px solid;
1250 border-color: #21376d;
1251}
1252
1253dl.bug {
1254 margin-left:-7px;
1255 padding-left: 3px;
1256 border-left:4px solid;
1257 border-color: #8f5902;
1258}
1259
1260dl.section dd {
1261 margin-bottom: 0.5rem;
1262}
1263
1264
1265#projectlogo {
1266 text-align: center;
1267 vertical-align: bottom;
1268 border-collapse: separate;
1269 padding-right: 1rem;
1270}
1271
1272#projectlogo img {
1273 border: 0px none;
1274 width: 8rem;
1275 height: auto;
1276}
1277
1278#projectname {
1279 font: inherit;
1280 font-size: 300%;
1281 margin: 0px;
1282 padding: 2px 0px;
1283}
1284
1285#projectbrief {
1286 font: inherit;
1287 font-size: 120%;
1288 margin: 0px;
1289 padding: 0px;
1290}
1291
1292#projectnumber {
1293 font: inherit;
1294 font-size: 50%;
1295 margin: 0px;
1296 padding: 0px;
1297}
1298
1299#titlearea {
1300 padding: 1rem;
1301 margin: 0px;
1302 width: auto;
1303 border-bottom: none;
1304 background-color: #fafbfc;
1305}
1306
1307.image {
1308 text-align: center;
1309}
1310
1311.dotgraph {
1312 text-align: center;
1313}
1314
1315.mscgraph {
1316 text-align: center;
1317}
1318
1319.caption {
1320 font-weight: bold;
1321}
1322
1323div.zoom {
1324 border: 1px solid #90A5CE;
1325}
1326
1327dl.citelist {
1328 margin-bottom:50px;
1329}
1330
1331dl.citelist dt {
1332 color:#334975;
1333 float:left;
1334 font-weight:bold;
1335 margin-right:10px;
1336 padding:5px;
1337}
1338
1339dl.citelist dd {
1340 margin:2px 0;
1341 padding:5px 0;
1342}
1343
1344div.toc {
1345 padding: 14px 25px;
1346 background-color: #F4F6FA;
1347 border: 1px solid #D8DFEE;
1348 border-radius: 7px 7px 7px 7px;
1349 float: right;
1350 height: auto;
1351 margin: 0 20px 10px 10px;
1352 width: 200px;
1353}
1354
1355div.toc li {
1356 background: url("bdwn.png") no-repeat scroll 0 5px transparent;
1357 font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif;
1358 margin-top: 5px;
1359 padding-left: 10px;
1360 padding-top: 2px;
1361}
1362
1363div.toc h3 {
1364 font: bold 12px/1.2 Arial,FreeSans,sans-serif;
1365 color: #4665A2;
1366 border-bottom: 0 none;
1367 margin: 0;
1368}
1369
1370div.toc ul {
1371 list-style: none outside none;
1372 border: medium none;
1373 padding: 0px;
1374}
1375
1376div.toc li.level1 {
1377 margin-left: 0px;
1378}
1379
1380div.toc li.level2 {
1381 margin-left: 15px;
1382}
1383
1384div.toc li.level3 {
1385 margin-left: 30px;
1386}
1387
1388div.toc li.level4 {
1389 margin-left: 45px;
1390}
1391
1392.inherit_header {
1393 font-weight: bold;
1394 color: gray;
1395 cursor: pointer;
1396 -webkit-touch-callout: none;
1397 -webkit-user-select: none;
1398 -khtml-user-select: none;
1399 -moz-user-select: none;
1400 -ms-user-select: none;
1401 user-select: none;
1402}
1403
1404.inherit_header td {
1405 padding: 6px 0px 2px 5px;
1406}
1407
1408.inherit {
1409 display: none;
1410}
1411
1412tr.heading h2 {
1413 padding-top: 1.75rem;
1414 margin-top: 0;
1415 margin-bottom: 1rem;
1416}
1417
1418@media print
1419{
1420 #top { display: none; }
1421 #side-nav { display: none; }
1422 #nav-path { display: none; }
1423 body { overflow:visible; }
1424 h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
1425 .summary { display: none; }
1426 .memitem { page-break-inside: avoid; }
1427 #doc-content {
1428 margin-left:0 !important;
1429 height:auto !important;
1430 width:auto !important;
1431 overflow:inherit;
1432 display:inline;
1433 }
1434}
1435
1436
1437.tabs, .tabs2, .tabs3 {
1438 background-image: none;
1439 background-color: #fafbfc;
1440 color: #24292e;
1441 padding: 0 1rem;
1442 font-family: inherit;
1443 font-size: inherit;
1444 width: auto;
1445}
1446
1447.tabs {
1448 border-bottom: 1px solid #e1e4e8;
1449}
1450
1451.tablist {
1452 position: relative;
1453 top: 1px;
1454}
1455
1456.tabs2 {
1457 margin-top: 1rem;
1458 border-bottom: 1px solid #e1e4e8;
1459 background-color: #fff;
1460}
1461
1462.tabs3 {
1463 margin-top: 1rem;
1464 border-bottom: 1px solid #e1e4e8;
1465 background-color: #fff;
1466}
1467
1468.tablist li {
1469 background-image: none;
1470}
1471
1472.tablist a {
1473 background-image: none;
1474 text-shadow: none;
1475 color: #586069;
1476 border: 1px solid transparent;
1477 border-top: 3px solid transparent;
1478 border-radius: 3px 3px 0 0;
1479 padding: 0 1rem;
1480}
1481
1482.tablist a:hover {
1483 background-image: none;
1484 text-shadow: none;
1485 color: #24292e;
1486}
1487
1488.tablist li.current a {
1489 text-shadow: none;
1490 background-image: none;
1491 background-color: #fff;
1492 color: #24292e;
1493}
1494
1495#navrow1 .tablist li.current a {
1496 border-color: #f7ae1a #e1e4e8 transparent;
1497}
1498
1499#navrow2 .tablist li.current a {
1500 border-color: #e45e25 #e1e4e8 transparent;
1501}
1502
1503#navrow3 .tablist li.current a {
1504 border-color: #1fa4a9 #e1e4e8 transparent;
1505}
1506
1507#navrow4 .tablist li.current a {
1508 border-color: #01496d #e1e4e8 transparent;
1509}
1510
1511.tabs li.current {
1512 background-color: #fff;
1513}
1514
1515.tabs2 li.current {
1516 background-color: #fff;
1517}
1518
1519.navpath {
1520 border: none;
1521 margin-top: 1rem;
1522 padding: 0 2rem;
1523}
1524
1525.navpath ul {
1526 background-color: transparent;
1527 border: none;
1528}
1529
1530.navpath li {
1531 padding: 0;
1532}
1533
1534.navpath li.navelem a {
1535 color: #005082;
1536 text-shadow: none;
1537 padding: 0 0.25rem;
1538 font-size: 1rem;
1539}
1540
1541.navpath li.navelem a:hover {
1542 color: #005082;
1543 text-shadow: none;
1544 text-decoration: underline;
1545}
1546
1547/* @group Markdown */
1548
1549table.markdownTable td,
1550table.markdownTable th {
1551 border: 1px solid #c6cbd1;
1552 padding: 0.5rem 1rem;
1553}
1554
1555.markdownTable tbody tr:nth-of-type(odd) {
1556 background-color: #f6f8fa;
1557}
1558
1559th.markdownTableHeadLeft,
1560th.markdownTableHeadRight,
1561th.markdownTableHeadCenter,
1562th.markdownTableHeadNone {
1563 background-color: #fff;
1564 color: inherit;
1565 font-size: inherit;
1566 font-weight: bold;
1567 padding: 0.5rem 1rem;
1568 text-align: inherit;
1569 -moz-border-radius-topleft: 3px;
1570 -moz-border-radius-topright: 3px;
1571 -webkit-border-top-left-radius: 3px;
1572 -webkit-border-top-right-radius: 3px;
1573 border-top-left-radius: 3px;
1574 border-top-right-radius: 3px;
1575 border-bottom: 1px solid #c6cbd1;
1576}
1577
1578/* @end */
1579
1580@media (max-width: 576px) {
1581 .navpath {
1582 padding: 0 1rem;
1583 }
1584
1585 .navpath li.navelem a {
1586 padding: 0;
1587 }
1588
1589 div.header {
1590 padding: 1rem 1rem 0 1rem;
1591 }
1592
1593 div.contents {
1594 padding: 1rem 1rem 0 1rem;
1595 }
1596
1597 hr.footer {
1598 margin-left: 1rem;
1599 margin-right: 1rem;
1600 }
1601
1602 address.footer {
1603 margin-left: 1rem;
1604 margin-right: 1rem;
1605 }
1606
1607 .memtitle {
1608 font-size: 1.5rem;
1609 word-break: break-all;
1610 }
1611
1612 .memname td {
1613 float: left;
1614 word-break: break-all;
1615 }
1616
1617 div.memitem {
1618 margin-bottom: 1rem;
1619 }
1620
1621 .memdoc table.params {
1622 word-break: break-word;
1623 }
1624
1625 div.memproto {
1626 display: table;
1627 }
1628
1629 dl.section dt {
1630 margin-bottom: 0.5rem;
1631 }
1632
1633 dl.section dd {
1634 margin-left: 0;
1635 word-break: break-word;
1636 }
1637
1638 .contents > table,
1639 .contents > table thead,
1640 .contents > table tbody,
1641 .contents > table th,
1642 .contents > table td,
1643 .contents > table tr {
1644 display: block;
1645 }
1646
1647 .contents table.directory,
1648 .contents table.directory thead,
1649 .contents table.directory tbody,
1650 .contents table.directory th,
1651 .contents table.directory td {
1652 display: block;
1653 }
1654
1655 .contents table.directory tr {
1656 }
1657
1658 div:not(.PageDoc) .contents table,
1659 div:not(.PageDoc) .contents thead,
1660 div:not(.PageDoc) .contents tbody,
1661 div:not(.PageDoc) .contents th,
1662 div:not(.PageDoc) .contents td,
1663 div:not(.PageDoc) .contents tr {
1664 display: block;
1665 }
1666
1667 .mdescLeft,
1668 .memItemLeft,
1669 .memTemplItemLeft {
1670 text-align: left;
1671 border-left: 1px solid #c8e1ff;
1672 border-right: 1px solid #c8e1ff;
1673 word-break: break-word;
1674 white-space: normal;
1675 padding-bottom: 0;
1676 }
1677
1678 table td.mdescLeft {
1679 display: none;
1680 }
1681
1682 table td.mdescRight,
1683 table td.memItemRight,
1684 table td.memTemplItemRight {
1685 border-top: none !important;
1686 border-left: 1px solid #c8e1ff;
1687 border-right: 1px solid #c8e1ff;
1688 display: table-cell;
1689 word-break: break-word;
1690 padding-top: 0;
1691 }
1692
1693 .directory td.desc {
1694 display: table-cell;
1695 }
1696
1697 dl.params dd {
1698 margin-left: 0;
1699 }
1700
1701 table.params td.paramname {
1702 margin-top: 0.5rem;
1703 }
1704
1705 #projectlogo img {
1706 border: 0px none;
1707 width: 4rem;
1708 height: auto;
1709 }
1710
1711 #projectname {
1712 font-size: 1rem;
1713 }
1714
1715 #projectbrief {
1716 font-size: 0.75rem;
1717 }
1718
1719 #projectnumber {
1720 font-size: 0.75rem;
1721 }
1722} \ No newline at end of file
diff --git a/docs/doxygen/favicon.ico b/docs/doxygen/favicon.ico
new file mode 100644
index 0000000..b542c5b
--- /dev/null
+++ b/docs/doxygen/favicon.ico
Binary files differ
diff --git a/docs/doxygen/folder-open.png b/docs/doxygen/folder-open.png
new file mode 100644
index 0000000..b67403d
--- /dev/null
+++ b/docs/doxygen/folder-open.png
Binary files differ
diff --git a/docs/doxygen/folder.png b/docs/doxygen/folder.png
new file mode 100644
index 0000000..901edc9
--- /dev/null
+++ b/docs/doxygen/folder.png
Binary files differ
diff --git a/docs/doxygen/footer.html b/docs/doxygen/footer.html
new file mode 100644
index 0000000..9eef78d
--- /dev/null
+++ b/docs/doxygen/footer.html
@@ -0,0 +1,9 @@
1<hr class="footer"/>
2<address class="footer">
3 <ul class="navpath">
4 <li class="footer">&copy; 2007-$year <a href="https://libimobiledevice.org">$projectname</a>&nbsp;&nbsp;All rights reserved</li>
5 <li class="footer">Generated on <em>$datetime</em> by <a href="https://www.doxygen.org">doxygen $doxygenversion</a></li>
6 <li class="footer">Icons by <a href="http://tango-project.org/">Tango</a></li>
7 <li class="footer">Design &copy; $year by <a href="https://mirell.com" target="_blank">Mirell</a></li>
8 </ui>
9</address> \ No newline at end of file
diff --git a/docs/doxygen/header.html b/docs/doxygen/header.html
new file mode 100644
index 0000000..bc41a11
--- /dev/null
+++ b/docs/doxygen/header.html
@@ -0,0 +1,64 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="doxygen $doxygenversion"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<!--BEGIN PROJECT_NAME--><title>$title - $projectname $projectnumber</title><!--END PROJECT_NAME-->
9<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
10
11<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
12
13<meta property="og:locale" content="en_US" />
14<meta property="og:type" content="website" />
15<meta property="og:title" content="$projectbrief - $projectname" />
16<meta property="og:url" content="https://libimobiledevice.org/docs/$projectname/$projectnumber/" />
17<meta property="og:site_name" content="$projectname - $projectbrief" />
18<meta name="twitter:card" content="summary_large_image" />
19
20<script type="text/javascript" src="$relpath^jquery.js"></script>
21<script type="text/javascript" src="$relpath^dynsections.js"></script>
22$treeview
23$search
24$mathjax
25<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
26$extrastylesheet
27</head>
28<body>
29<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
30
31<!--BEGIN TITLEAREA-->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <!--BEGIN PROJECT_LOGO-->
37 <td id="projectlogo"><a href="$relpath^index.html"><img alt="Logo" src="$relpath^$projectlogo"/></a></td>
38 <!--END PROJECT_LOGO-->
39 <!--BEGIN PROJECT_NAME-->
40 <td id="projectalign" style="padding-left: 0.5em;">
41 <div id="projectname">$projectname
42 <!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
43 </div>
44 <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief - <a href="https://libimobiledevice.org"><small>Return to Homepage</small></a></div><!--END PROJECT_BRIEF-->
45 </td>
46 <!--END PROJECT_NAME-->
47 <!--BEGIN !PROJECT_NAME-->
48 <!--BEGIN PROJECT_BRIEF-->
49 <td style="padding-left: 0.5em;">
50 <div id="projectbrief">$projectbrief</div>
51 </td>
52 <!--END PROJECT_BRIEF-->
53 <!--END !PROJECT_NAME-->
54 <!--BEGIN DISABLE_INDEX-->
55 <!--BEGIN SEARCHENGINE-->
56 <td>$searchbox</td>
57 <!--END SEARCHENGINE-->
58 <!--END DISABLE_INDEX-->
59 </tr>
60 </tbody>
61</table>
62</div>
63<!--END TITLEAREA-->
64<!-- end header part --> \ No newline at end of file
diff --git a/docs/doxygen/layout.xml b/docs/doxygen/layout.xml
new file mode 100644
index 0000000..46f068d
--- /dev/null
+++ b/docs/doxygen/layout.xml
@@ -0,0 +1,226 @@
1<doxygenlayout version="1.0">
2 <!-- Generated by doxygen 1.8.16 -->
3 <!-- Navigation index tabs for HTML output -->
4 <navindex>
5 <tab type="mainpage" visible="yes" title="About"/>
6 <tab type="modules" visible="yes" title="" intro=""/>
7 <tab type="namespaces" visible="yes" title="">
8 <tab type="namespacelist" visible="yes" title="" intro=""/>
9 <tab type="namespacemembers" visible="yes" title="" intro=""/>
10 </tab>
11 <tab type="interfaces" visible="yes" title="">
12 <tab type="interfacelist" visible="yes" title="" intro=""/>
13 <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
14 <tab type="interfacehierarchy" visible="yes" title="" intro=""/>
15 </tab>
16 <tab type="classes" visible="yes" title="">
17 <tab type="classlist" visible="yes" title="" intro=""/>
18 <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
19 <tab type="hierarchy" visible="yes" title="" intro=""/>
20 <tab type="classmembers" visible="yes" title="" intro=""/>
21 </tab>
22 <tab type="structs" visible="yes" title="">
23 <tab type="structlist" visible="yes" title="" intro=""/>
24 <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
25 </tab>
26 <tab type="exceptions" visible="yes" title="">
27 <tab type="exceptionlist" visible="yes" title="" intro=""/>
28 <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
29 <tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
30 </tab>
31 <tab type="files" visible="yes" title="">
32 <tab type="filelist" visible="yes" title="" intro=""/>
33 <tab type="globals" visible="yes" title="" intro=""/>
34 </tab>
35 <tab type="examples" visible="yes" title="" intro=""/>
36 <tab type="pages" visible="yes" title="" intro=""/>
37 </navindex>
38
39 <!-- Layout definition for a class page -->
40 <class>
41 <briefdescription visible="no"/>
42 <detaileddescription title="Description"/>
43 <includes visible="$SHOW_INCLUDE_FILES"/>
44 <inheritancegraph visible="$CLASS_GRAPH"/>
45 <collaborationgraph visible="$COLLABORATION_GRAPH"/>
46 <memberdecl>
47 <nestedclasses visible="yes" title=""/>
48 <publictypes title=""/>
49 <services title=""/>
50 <interfaces title=""/>
51 <publicslots title=""/>
52 <signals title=""/>
53 <publicmethods title=""/>
54 <publicstaticmethods title=""/>
55 <publicattributes title=""/>
56 <publicstaticattributes title=""/>
57 <protectedtypes title=""/>
58 <protectedslots title=""/>
59 <protectedmethods title=""/>
60 <protectedstaticmethods title=""/>
61 <protectedattributes title=""/>
62 <protectedstaticattributes title=""/>
63 <packagetypes title=""/>
64 <packagemethods title=""/>
65 <packagestaticmethods title=""/>
66 <packageattributes title=""/>
67 <packagestaticattributes title=""/>
68 <properties title=""/>
69 <events title=""/>
70 <privatetypes title=""/>
71 <privateslots title=""/>
72 <privatemethods title=""/>
73 <privatestaticmethods title=""/>
74 <privateattributes title=""/>
75 <privatestaticattributes title=""/>
76 <friends title=""/>
77 <related title="" subtitle=""/>
78 <membergroups visible="yes"/>
79 </memberdecl>
80 <memberdef>
81 <inlineclasses title=""/>
82 <typedefs title=""/>
83 <enums title=""/>
84 <services title=""/>
85 <interfaces title=""/>
86 <constructors title=""/>
87 <functions title=""/>
88 <related title=""/>
89 <variables title=""/>
90 <properties title=""/>
91 <events title=""/>
92 </memberdef>
93 <allmemberslink visible="yes"/>
94 <usedfiles visible="$SHOW_USED_FILES"/>
95 <authorsection visible="yes"/>
96 </class>
97
98 <!-- Layout definition for a namespace page -->
99 <namespace>
100 <briefdescription visible="no"/>
101 <detaileddescription title="Description"/>
102 <memberdecl>
103 <nestednamespaces visible="yes" title=""/>
104 <constantgroups visible="yes" title=""/>
105 <interfaces visible="yes" title=""/>
106 <classes visible="yes" title=""/>
107 <structs visible="yes" title=""/>
108 <exceptions visible="yes" title=""/>
109 <typedefs title=""/>
110 <sequences title=""/>
111 <dictionaries title=""/>
112 <enums title=""/>
113 <functions title=""/>
114 <variables title=""/>
115 <membergroups visible="yes"/>
116 </memberdecl>
117 <memberdef>
118 <inlineclasses title=""/>
119 <typedefs title=""/>
120 <sequences title=""/>
121 <dictionaries title=""/>
122 <enums title=""/>
123 <functions title=""/>
124 <variables title=""/>
125 </memberdef>
126 <authorsection visible="yes"/>
127 </namespace>
128
129 <!-- Layout definition for a file page -->
130 <file>
131 <briefdescription visible="no"/>
132 <detaileddescription title="Description"/>
133 <includes visible="$SHOW_INCLUDE_FILES"/>
134 <includegraph visible="$INCLUDE_GRAPH"/>
135 <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
136 <memberdecl>
137 <interfaces visible="yes" title=""/>
138 <classes visible="yes" title=""/>
139 <structs visible="yes" title=""/>
140 <exceptions visible="yes" title=""/>
141 <namespaces visible="yes" title=""/>
142 <constantgroups visible="yes" title=""/>
143 <defines title=""/>
144 <typedefs title=""/>
145 <sequences title=""/>
146 <dictionaries title=""/>
147 <enums title=""/>
148 <functions title=""/>
149 <variables title=""/>
150 <membergroups visible="yes"/>
151 </memberdecl>
152 <memberdef>
153 <inlineclasses title=""/>
154 <defines title=""/>
155 <typedefs title=""/>
156 <sequences title=""/>
157 <dictionaries title=""/>
158 <enums title=""/>
159 <functions title=""/>
160 <variables title=""/>
161 </memberdef>
162 <authorsection/>
163 <sourcelink visible="yes"/>
164 </file>
165
166 <!-- Layout definition for a group page -->
167 <group>
168 <briefdescription visible="no"/>
169 <detaileddescription title="Description"/>
170 <groupgraph visible="$GROUP_GRAPHS"/>
171 <memberdecl>
172 <nestedgroups visible="yes" title=""/>
173 <dirs visible="yes" title=""/>
174 <files visible="yes" title=""/>
175 <namespaces visible="yes" title=""/>
176 <classes visible="yes" title=""/>
177 <defines title=""/>
178 <typedefs title=""/>
179 <sequences title=""/>
180 <dictionaries title=""/>
181 <enums title=""/>
182 <enumvalues title=""/>
183 <functions title=""/>
184 <variables title=""/>
185 <signals title=""/>
186 <publicslots title=""/>
187 <protectedslots title=""/>
188 <privateslots title=""/>
189 <events title=""/>
190 <properties title=""/>
191 <friends title=""/>
192 <membergroups visible="yes"/>
193 </memberdecl>
194 <memberdef>
195 <pagedocs/>
196 <inlineclasses title=""/>
197 <defines title=""/>
198 <typedefs title=""/>
199 <sequences title=""/>
200 <dictionaries title=""/>
201 <enums title=""/>
202 <enumvalues title=""/>
203 <functions title=""/>
204 <variables title=""/>
205 <signals title=""/>
206 <publicslots title=""/>
207 <protectedslots title=""/>
208 <privateslots title=""/>
209 <events title=""/>
210 <properties title=""/>
211 <friends title=""/>
212 </memberdef>
213 <authorsection visible="yes"/>
214 </group>
215
216 <!-- Layout definition for a directory page -->
217 <directory>
218 <briefdescription visible="no"/>
219 <detaileddescription title="Description"/>
220 <directorygraph visible="yes"/>
221 <memberdecl>
222 <dirs visible="yes"/>
223 <files visible="yes"/>
224 </memberdecl>
225 </directory>
226</doxygenlayout> \ No newline at end of file
diff --git a/docs/doxygen/logo-vector-clean.svg b/docs/doxygen/logo-vector-clean.svg
new file mode 100644
index 0000000..a953115
--- /dev/null
+++ b/docs/doxygen/logo-vector-clean.svg
@@ -0,0 +1 @@
<svg enable-background="new 0 0 283.5 283.5" height="793.7" viewBox="0 0 793.7 793.7" width="793.7" xmlns="http://www.w3.org/2000/svg"><g stroke-width=".10005" transform="matrix(13.831 0 0 13.831 -1173.2 -291.34)"><path d="m94.968 35.193v-10.71l9.2751 5.355z" fill="#f7ae1a"/><path d="m94.968 35.193 9.2751-5.355v10.71z" fill="#e45e25"/><path d="m94.968 42.414 9.2751 5.355-9.2751 5.355z" fill="#d2343e"/><path d="m94.968 53.124 9.2751-5.355v10.71z" fill="#bb2033"/><path d="m94.968 53.124 9.2751 5.355-9.2751 5.355z" fill="#ab2333"/></g><g fill="#2e3436" fill-opacity=".19964" transform="matrix(13.831 0 0 13.831 -1361.02498 -319.002)"><path d="m57.472 29.867h-55.452l27.726-48.023z" stroke-width=".518" transform="matrix(-.16726 .09657 -.09657 -.16726 121.04 71.121)"/><path d="m148.27 69.213h-10.71l5.355-9.2751z" stroke-width=".10005" transform="matrix(-.86603 .5 .5 .86603 211.62 -57.046)"/><path d="m142.92-59.938h-10.71l5.355-9.2751z" stroke-width=".10005" transform="matrix(-.8660254 .5 -.5 -.8660254 211.614597 -57.0459)"/><path d="m57.472 29.867h-55.452l27.726-48.023z" stroke-width=".518" transform="matrix(0 .19314 -.19314 0 132.86 60.576)"/><path d="m57.472 29.867h-55.452l27.726-48.023z" stroke-width=".518" transform="matrix(.16726 .09657 -.09657 .16726 129.64 55.775)"/><path d="m57.472 29.867h-55.452l27.726-48.023z" transform="matrix(0 .19314 -.19314 0 142.13 55.221)"/></g><g transform="matrix(13.831 0 0 13.831 -1173.2 -291.34)"><g stroke-width=".10005"><path d="m94.968 63.834 9.2751-5.355v10.71z" fill="#7b2f44"/><path d="m104.24 69.189 9.2751-5.355-9.2751-5.355z" fill="#21376d"/><path d="m104.24 58.479 9.2751-5.355v10.71z" fill="#005082"/><path d="m113.52 63.834v-10.71l9.2751 5.355z" fill="#023e49"/><path d="m122.79 58.479-9.2751-5.355 9.2751-5.355z" fill="#007e96"/></g><path d="m122.79 58.479v-10.71l9.2751 5.355z" fill="#0a9197"/></g><g fill="#ccc" transform="translate(2.808 194.51)"><polygon/><polygon/></g></svg> \ No newline at end of file
diff --git a/docs/doxygen/text-x-generic.png b/docs/doxygen/text-x-generic.png
new file mode 100644
index 0000000..2d7f2d6
--- /dev/null
+++ b/docs/doxygen/text-x-generic.png
Binary files differ
diff --git a/doxygen.cfg.in b/doxygen.cfg.in
index 7aa54e8..eb84c85 100644
--- a/doxygen.cfg.in
+++ b/doxygen.cfg.in
@@ -1,630 +1,1105 @@
1# Doxyfile 1.5.6 1# Doxyfile 1.11.0
2 2
3# This file describes the settings to be used by the documentation system 3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project 4# doxygen (www.doxygen.org) for a project.
5# 5#
6# All text after a hash (#) is considered a comment and will be ignored 6# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
7# The format is: 10# The format is:
8# TAG = value [value, ...] 11# TAG = value [value, ...]
9# For lists items can also be appended using: 12# For lists, items can also be appended using:
10# TAG += value [value, ...] 13# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ") 14# Values that contain spaces should be placed between quotes (\" \").
15#
16# Note:
17#
18# Use doxygen to compare the used configuration file with the template
19# configuration file:
20# doxygen -x [configFile]
21# Use doxygen to compare the used configuration file with the template
22# configuration file without replacing the environment variables or CMake type
23# replacement variables:
24# doxygen -x_noenv [configFile]
12 25
13#--------------------------------------------------------------------------- 26#---------------------------------------------------------------------------
14# Project related configuration options 27# Project related configuration options
15#--------------------------------------------------------------------------- 28#---------------------------------------------------------------------------
16 29
17# This tag specifies the encoding used for all characters in the config file 30# This tag specifies the encoding used for all characters in the configuration
18# that follow. The default is UTF-8 which is also the encoding used for all 31# file that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the 32# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See 33# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings. 34# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
35# The default value is: UTF-8.
22 36
23DOXYFILE_ENCODING = UTF-8 37DOXYFILE_ENCODING = UTF-8
24 38
25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 39# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
26# by quotes) that should identify the project. 40# double-quotes, unless you are using Doxywizard) that should identify the
41# project for which the documentation is generated. This name is used in the
42# title of most generated pages and in a few other places.
43# The default value is: My Project.
27 44
28PROJECT_NAME = @PACKAGE@ 45PROJECT_NAME = @PACKAGE@
29 46
30# The PROJECT_NUMBER tag can be used to enter a project or revision number. 47# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
31# This could be handy for archiving the generated documentation or 48# could be handy for archiving the generated documentation or if some version
32# if some version control system is used. 49# control system is used.
33 50
34PROJECT_NUMBER = @VERSION@ 51PROJECT_NUMBER = @VERSION@
35 52
36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 53# Using the PROJECT_BRIEF tag one can provide an optional one line description
37# base path where the generated documentation will be put. 54# for a project that appears at the top of each page and should give viewer a
38# If a relative path is entered, it will be relative to the location 55# quick idea about the purpose of the project. Keep the description short.
39# where doxygen was started. If left blank the current directory will be used. 56
57PROJECT_BRIEF = "API Documentation"
58
59# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
60# in the documentation. The maximum height of the logo should not exceed 55
61# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
62# the logo to the output directory.
63
64PROJECT_LOGO = docs/doxygen/logo-vector-clean.svg
65
66# With the PROJECT_ICON tag one can specify an icon that is included in the tabs
67# when the HTML document is shown. Doxygen will copy the logo to the output
68# directory.
69
70PROJECT_ICON =
71
72# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
73# into which the generated documentation will be written. If a relative path is
74# entered, it will be relative to the location where doxygen was started. If
75# left blank the current directory will be used.
40 76
41OUTPUT_DIRECTORY = docs 77OUTPUT_DIRECTORY = docs
42 78
43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 79# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
44# 4096 sub-directories (in 2 levels) under the output directory of each output 80# sub-directories (in 2 levels) under the output directory of each output format
45# format and will distribute the generated files over these directories. 81# and will distribute the generated files over these directories. Enabling this
46# Enabling this option can be useful when feeding doxygen a huge amount of 82# option can be useful when feeding doxygen a huge amount of source files, where
47# source files, where putting all generated files in the same directory would 83# putting all generated files in the same directory would otherwise causes
48# otherwise cause performance problems for the file system. 84# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
85# control the number of sub-directories.
86# The default value is: NO.
49 87
50CREATE_SUBDIRS = NO 88CREATE_SUBDIRS = NO
51 89
52# The OUTPUT_LANGUAGE tag is used to specify the language in which all 90# Controls the number of sub-directories that will be created when
53# documentation generated by doxygen is written. Doxygen will use this 91# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
54# information to generate all constant output in the proper language. 92# level increment doubles the number of directories, resulting in 4096
55# The default language is English, other supported languages are: 93# directories at level 8 which is the default and also the maximum value. The
56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 94# sub-directories are organized in 2 levels, the first level always has a fixed
57# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 95# number of 16 directories.
58# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 96# Minimum value: 0, maximum value: 8, default value: 8.
59# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 97# This tag requires that the tag CREATE_SUBDIRS is set to YES.
60# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 98
61# and Ukrainian. 99CREATE_SUBDIRS_LEVEL = 8
100
101# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
102# characters to appear in the names of generated files. If set to NO, non-ASCII
103# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
104# U+3044.
105# The default value is: NO.
106
107ALLOW_UNICODE_NAMES = NO
108
109# The OUTPUT_LANGUAGE tag is used to specify the language in which all
110# documentation generated by doxygen is written. Doxygen will use this
111# information to generate all constant output in the proper language.
112# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,
113# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
114# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
115# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
116# English messages), Korean, Korean-en (Korean with English messages), Latvian,
117# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
118# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
119# Swedish, Turkish, Ukrainian and Vietnamese.
120# The default value is: English.
62 121
63OUTPUT_LANGUAGE = English 122OUTPUT_LANGUAGE = English
64 123
65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 124# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
66# include brief member descriptions after the members that are listed in 125# descriptions after the members that are listed in the file and class
67# the file and class documentation (similar to JavaDoc). 126# documentation (similar to Javadoc). Set to NO to disable this.
68# Set to NO to disable this. 127# The default value is: YES.
69 128
70BRIEF_MEMBER_DESC = YES 129BRIEF_MEMBER_DESC = YES
71 130
72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 131# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
73# the brief description of a member or function before the detailed description. 132# description of a member or function before the detailed description
74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 133#
134# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75# brief descriptions will be completely suppressed. 135# brief descriptions will be completely suppressed.
136# The default value is: YES.
76 137
77REPEAT_BRIEF = YES 138REPEAT_BRIEF = YES
78 139
79# This tag implements a quasi-intelligent brief description abbreviator 140# This tag implements a quasi-intelligent brief description abbreviator that is
80# that is used to form the text in various listings. Each string 141# used to form the text in various listings. Each string in this list, if found
81# in this list, if found as the leading text of the brief description, will be 142# as the leading text of the brief description, will be stripped from the text
82# stripped from the text and the result after processing the whole list, is 143# and the result, after processing the whole list, is used as the annotated
83# used as the annotated text. Otherwise, the brief description is used as-is. 144# text. Otherwise, the brief description is used as-is. If left blank, the
84# If left blank, the following values are used ("$name" is automatically 145# following values are used ($name is automatically replaced with the name of
85# replaced with the name of the entity): "The $name class" "The $name widget" 146# the entity):The $name class, The $name widget, The $name file, is, provides,
86# "The $name file" "is" "provides" "specifies" "contains" 147# specifies, contains, represents, a, an and the.
87# "represents" "a" "an" "the"
88 148
89ABBREVIATE_BRIEF = 149ABBREVIATE_BRIEF =
90 150
91# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 151# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92# Doxygen will generate a detailed section even if there is only a brief 152# doxygen will generate a detailed section even if there is only a brief
93# description. 153# description.
154# The default value is: NO.
94 155
95ALWAYS_DETAILED_SEC = NO 156ALWAYS_DETAILED_SEC = NO
96 157
97# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 158# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98# inherited members of a class in the documentation of that class as if those 159# inherited members of a class in the documentation of that class as if those
99# members were ordinary class members. Constructors, destructors and assignment 160# members were ordinary class members. Constructors, destructors and assignment
100# operators of the base classes will not be shown. 161# operators of the base classes will not be shown.
162# The default value is: NO.
101 163
102INLINE_INHERITED_MEMB = NO 164INLINE_INHERITED_MEMB = NO
103 165
104# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 166# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
105# path before files name in the file list and in the header files. If set 167# before files name in the file list and in the header files. If set to NO the
106# to NO the shortest path that makes the file name unique will be used. 168# shortest path that makes the file name unique will be used
169# The default value is: YES.
107 170
108FULL_PATH_NAMES = YES 171FULL_PATH_NAMES = YES
109 172
110# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 173# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
111# can be used to strip a user-defined part of the path. Stripping is 174# Stripping is only done if one of the specified strings matches the left-hand
112# only done if one of the specified strings matches the left-hand part of 175# part of the path. The tag can be used to show relative paths in the file list.
113# the path. The tag can be used to show relative paths in the file list. 176# If left blank the directory from which doxygen is run is used as the path to
114# If left blank the directory from which doxygen is run is used as the 177# strip.
115# path to strip. 178#
179# Note that you can specify absolute paths here, but also relative paths, which
180# will be relative from the directory where doxygen is started.
181# This tag requires that the tag FULL_PATH_NAMES is set to YES.
116 182
117STRIP_FROM_PATH = include 183STRIP_FROM_PATH = include
118 184
119# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 185# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
120# the path mentioned in the documentation of a class, which tells 186# path mentioned in the documentation of a class, which tells the reader which
121# the reader which header file to include in order to use a class. 187# header file to include in order to use a class. If left blank only the name of
122# If left blank only the name of the header file containing the class 188# the header file containing the class definition is used. Otherwise one should
123# definition is used. Otherwise one should specify the include paths that 189# specify the list of include paths that are normally passed to the compiler
124# are normally passed to the compiler using the -I flag. 190# using the -I flag.
125 191
126STRIP_FROM_INC_PATH = 192STRIP_FROM_INC_PATH =
127 193
128# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 194# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
129# (but less readable) file names. This can be useful is your file systems 195# less readable) file names. This can be useful is your file systems doesn't
130# doesn't support long names like on DOS, Mac, or CD-ROM. 196# support long names like on DOS, Mac, or CD-ROM.
197# The default value is: NO.
131 198
132SHORT_NAMES = NO 199SHORT_NAMES = NO
133 200
134# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 201# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
135# will interpret the first line (until the first dot) of a JavaDoc-style 202# first line (until the first dot) of a Javadoc-style comment as the brief
136# comment as the brief description. If set to NO, the JavaDoc 203# description. If set to NO, the Javadoc-style will behave just like regular Qt-
137# comments will behave just like regular Qt-style comments 204# style comments (thus requiring an explicit @brief command for a brief
138# (thus requiring an explicit @brief command for a brief description.) 205# description.)
206# The default value is: NO.
139 207
140JAVADOC_AUTOBRIEF = YES 208JAVADOC_AUTOBRIEF = YES
141 209
142# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 210# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
143# interpret the first line (until the first dot) of a Qt-style 211# such as
144# comment as the brief description. If set to NO, the comments 212# /***************
145# will behave just like regular Qt-style comments (thus requiring 213# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
146# an explicit \brief command for a brief description.) 214# Javadoc-style will behave just like regular comments and it will not be
215# interpreted by doxygen.
216# The default value is: NO.
217
218JAVADOC_BANNER = NO
219
220# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
221# line (until the first dot) of a Qt-style comment as the brief description. If
222# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
223# requiring an explicit \brief command for a brief description.)
224# The default value is: NO.
147 225
148QT_AUTOBRIEF = NO 226QT_AUTOBRIEF = NO
149 227
150# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 228# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
151# treat a multi-line C++ special comment block (i.e. a block of //! or /// 229# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
152# comments) as a brief description. This used to be the default behaviour. 230# a brief description. This used to be the default behavior. The new default is
153# The new default is to treat a multi-line C++ comment block as a detailed 231# to treat a multi-line C++ comment block as a detailed description. Set this
154# description. Set this tag to YES if you prefer the old behaviour instead. 232# tag to YES if you prefer the old behavior instead.
233#
234# Note that setting this tag to YES also means that rational rose comments are
235# not recognized any more.
236# The default value is: NO.
155 237
156MULTILINE_CPP_IS_BRIEF = NO 238MULTILINE_CPP_IS_BRIEF = NO
157 239
158# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 240# By default Python docstrings are displayed as preformatted text and doxygen's
159# member inherits the documentation from any documented member that it 241# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
160# re-implements. 242# doxygen's special commands can be used and the contents of the docstring
243# documentation blocks is shown as doxygen documentation.
244# The default value is: YES.
161 245
162INHERIT_DOCS = YES 246PYTHON_DOCSTRING = YES
163 247
164# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 248# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
165# a new page for each member. If set to NO, the documentation of a member will 249# documentation from any documented member that it re-implements.
166# be part of the file/class/namespace that contains it. 250# The default value is: YES.
167 251
168SEPARATE_MEMBER_PAGES = NO 252INHERIT_DOCS = YES
169 253
170# The TAB_SIZE tag can be used to set the number of spaces in a tab. 254# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
171# Doxygen uses this value to replace tabs by spaces in code fragments. 255# page for each member. If set to NO, the documentation of a member will be part
256# of the file/class/namespace that contains it.
257# The default value is: NO.
172 258
173TAB_SIZE = 8 259SEPARATE_MEMBER_PAGES = YES
174 260
175# This tag can be used to specify a number of aliases that acts 261# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
176# as commands in the documentation. An alias has the form "name=value". 262# uses this value to replace tabs by spaces in code fragments.
177# For example adding "sideeffect=\par Side Effects:\n" will allow you to 263# Minimum value: 1, maximum value: 16, default value: 4.
178# put the command \sideeffect (or @sideeffect) in the documentation, which
179# will result in a user-defined paragraph with heading "Side Effects:".
180# You can put \n's in the value part of an alias to insert newlines.
181 264
182ALIASES = 265TAB_SIZE = 8
183 266
184# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 267# This tag can be used to specify a number of aliases that act as commands in
185# sources only. Doxygen will then generate output that is more tailored for C. 268# the documentation. An alias has the form:
186# For instance, some of the names that are used will be different. The list 269# name=value
187# of all members will be omitted, etc. 270# For example adding
271# "sideeffect=@par Side Effects:^^"
272# will allow you to put the command \sideeffect (or @sideeffect) in the
273# documentation, which will result in a user-defined paragraph with heading
274# "Side Effects:". Note that you cannot put \n's in the value part of an alias
275# to insert newlines (in the resulting output). You can put ^^ in the value part
276# of an alias to insert a newline as if a physical newline was in the original
277# file. When you need a literal { or } or , in the value part of an alias you
278# have to escape them by means of a backslash (\), this can lead to conflicts
279# with the commands \{ and \} for these it is advised to use the version @{ and
280# @} or use a double escape (\\{ and \\})
281
282ALIASES =
283
284# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
285# only. Doxygen will then generate output that is more tailored for C. For
286# instance, some of the names that are used will be different. The list of all
287# members will be omitted, etc.
288# The default value is: NO.
188 289
189OPTIMIZE_OUTPUT_FOR_C = YES 290OPTIMIZE_OUTPUT_FOR_C = YES
190 291
191# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 292# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
192# sources only. Doxygen will then generate output that is more tailored for 293# Python sources only. Doxygen will then generate output that is more tailored
193# Java. For instance, namespaces will be presented as packages, qualified 294# for that language. For instance, namespaces will be presented as packages,
194# scopes will look different, etc. 295# qualified scopes will look different, etc.
296# The default value is: NO.
195 297
196OPTIMIZE_OUTPUT_JAVA = NO 298OPTIMIZE_OUTPUT_JAVA = NO
197 299
198# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 300# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199# sources only. Doxygen will then generate output that is more tailored for 301# sources. Doxygen will then generate output that is tailored for Fortran.
200# Fortran. 302# The default value is: NO.
201 303
202OPTIMIZE_FOR_FORTRAN = NO 304OPTIMIZE_FOR_FORTRAN = NO
203 305
204# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 306# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205# sources. Doxygen will then generate output that is tailored for 307# sources. Doxygen will then generate output that is tailored for VHDL.
206# VHDL. 308# The default value is: NO.
207 309
208OPTIMIZE_OUTPUT_VHDL = NO 310OPTIMIZE_OUTPUT_VHDL = NO
209 311
210# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 312# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
211# to include (a tag file for) the STL sources as input, then you should 313# sources only. Doxygen will then generate output that is more tailored for that
212# set this tag to YES in order to let doxygen match functions declarations and 314# language. For instance, namespaces will be presented as modules, types will be
213# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 315# separated into more groups, etc.
214# func(std::string) {}). This also make the inheritance and collaboration 316# The default value is: NO.
215# diagrams that involve STL classes more complete and accurate. 317
318OPTIMIZE_OUTPUT_SLICE = YES
319
320# Doxygen selects the parser to use depending on the extension of the files it
321# parses. With this tag you can assign which parser to use for a given
322# extension. Doxygen has a built-in mapping, but you can override or extend it
323# using this tag. The format is ext=language, where ext is a file extension, and
324# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
325# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
326# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
327# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
328# tries to guess whether the code is fixed or free formatted code, this is the
329# default for Fortran type files). For instance to make doxygen treat .inc files
330# as Fortran files (default is PHP), and .f files as C (default is Fortran),
331# use: inc=Fortran f=C.
332#
333# Note: For files without extension you can use no_extension as a placeholder.
334#
335# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
336# the files are not read by doxygen. When specifying no_extension you should add
337# * to the FILE_PATTERNS.
338#
339# Note see also the list of default file extension mappings.
340
341EXTENSION_MAPPING =
342
343# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
344# according to the Markdown format, which allows for more readable
345# documentation. See https://daringfireball.net/projects/markdown/ for details.
346# The output of markdown processing is further processed by doxygen, so you can
347# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
348# case of backward compatibilities issues.
349# The default value is: YES.
350
351MARKDOWN_SUPPORT = YES
352
353# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
354# to that level are automatically included in the table of contents, even if
355# they do not have an id attribute.
356# Note: This feature currently applies only to Markdown headings.
357# Minimum value: 0, maximum value: 99, default value: 6.
358# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
359
360TOC_INCLUDE_HEADINGS = 5
361
362# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
363# generate identifiers for the Markdown headings. Note: Every identifier is
364# unique.
365# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a
366# sequence number starting at 0 and GITHUB use the lower case version of title
367# with any whitespace replaced by '-' and punctuation characters removed.
368# The default value is: DOXYGEN.
369# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
370
371MARKDOWN_ID_STYLE = DOXYGEN
372
373# When enabled doxygen tries to link words that correspond to documented
374# classes, or namespaces to their corresponding documentation. Such a link can
375# be prevented in individual cases by putting a % sign in front of the word or
376# globally by setting AUTOLINK_SUPPORT to NO.
377# The default value is: YES.
378
379AUTOLINK_SUPPORT = YES
380
381# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
382# to include (a tag file for) the STL sources as input, then you should set this
383# tag to YES in order to let doxygen match functions declarations and
384# definitions whose arguments contain STL classes (e.g. func(std::string);
385# versus func(std::string) {}). This also makes the inheritance and
386# collaboration diagrams that involve STL classes more complete and accurate.
387# The default value is: NO.
216 388
217BUILTIN_STL_SUPPORT = NO 389BUILTIN_STL_SUPPORT = NO
218 390
219# If you use Microsoft's C++/CLI language, you should set this option to YES to 391# If you use Microsoft's C++/CLI language, you should set this option to YES to
220# enable parsing support. 392# enable parsing support.
393# The default value is: NO.
221 394
222CPP_CLI_SUPPORT = NO 395CPP_CLI_SUPPORT = NO
223 396
224# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 397# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
225# Doxygen will parse them like normal C++ but will assume all classes use public 398# https://www.riverbankcomputing.com/software) sources only. Doxygen will parse
226# instead of private inheritance when no explicit protection keyword is present. 399# them like normal C++ but will assume all classes use public instead of private
400# inheritance when no explicit protection keyword is present.
401# The default value is: NO.
227 402
228SIP_SUPPORT = NO 403SIP_SUPPORT = NO
229 404
230# For Microsoft's IDL there are propget and propput attributes to indicate getter 405# For Microsoft's IDL there are propget and propput attributes to indicate
231# and setter methods for a property. Setting this option to YES (the default) 406# getter and setter methods for a property. Setting this option to YES will make
232# will make doxygen to replace the get and set methods by a property in the 407# doxygen to replace the get and set methods by a property in the documentation.
233# documentation. This will only work if the methods are indeed getting or 408# This will only work if the methods are indeed getting or setting a simple
234# setting a simple type. If this is not the case, or you want to show the 409# type. If this is not the case, or you want to show the methods anyway, you
235# methods anyway, you should set this option to NO. 410# should set this option to NO.
411# The default value is: YES.
236 412
237IDL_PROPERTY_SUPPORT = YES 413IDL_PROPERTY_SUPPORT = YES
238 414
239# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 415# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
240# tag is set to YES, then doxygen will reuse the documentation of the first 416# tag is set to YES then doxygen will reuse the documentation of the first
241# member in the group (if any) for the other members of the group. By default 417# member in the group (if any) for the other members of the group. By default
242# all members of a group must be documented explicitly. 418# all members of a group must be documented explicitly.
419# The default value is: NO.
243 420
244DISTRIBUTE_GROUP_DOC = NO 421DISTRIBUTE_GROUP_DOC = NO
245 422
246# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 423# If one adds a struct or class to a group and this option is enabled, then also
247# the same type (for instance a group of public functions) to be put as a 424# any nested class or struct is added to the same group. By default this option
248# subgroup of that type (e.g. under the Public Functions section). Set it to 425# is disabled and one has to add nested compounds explicitly via \ingroup.
249# NO to prevent subgrouping. Alternatively, this can be done per class using 426# The default value is: NO.
250# the \nosubgrouping command. 427
428GROUP_NESTED_COMPOUNDS = NO
429
430# Set the SUBGROUPING tag to YES to allow class member groups of the same type
431# (for instance a group of public functions) to be put as a subgroup of that
432# type (e.g. under the Public Functions section). Set it to NO to prevent
433# subgrouping. Alternatively, this can be done per class using the
434# \nosubgrouping command.
435# The default value is: YES.
251 436
252SUBGROUPING = NO 437SUBGROUPING = NO
253 438
254# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 439# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
255# is documented as struct, union, or enum with the name of the typedef. So 440# are shown inside the group in which they are included (e.g. using \ingroup)
256# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 441# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
257# with name TypeT. When disabled the typedef will appear as a member of a file, 442# and RTF).
258# namespace, or class. And the struct will be named TypeS. This can typically 443#
259# be useful for C code in case the coding convention dictates that all compound 444# Note that this feature does not work in combination with
445# SEPARATE_MEMBER_PAGES.
446# The default value is: NO.
447
448INLINE_GROUPED_CLASSES = NO
449
450# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
451# with only public data fields or simple typedef fields will be shown inline in
452# the documentation of the scope in which they are defined (i.e. file,
453# namespace, or group documentation), provided this scope is documented. If set
454# to NO, structs, classes, and unions are shown on a separate page (for HTML and
455# Man pages) or section (for LaTeX and RTF).
456# The default value is: NO.
457
458INLINE_SIMPLE_STRUCTS = NO
459
460# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
461# enum is documented as struct, union, or enum with the name of the typedef. So
462# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
463# with name TypeT. When disabled the typedef will appear as a member of a file,
464# namespace, or class. And the struct will be named TypeS. This can typically be
465# useful for C code in case the coding convention dictates that all compound
260# types are typedef'ed and only the typedef is referenced, never the tag name. 466# types are typedef'ed and only the typedef is referenced, never the tag name.
467# The default value is: NO.
261 468
262TYPEDEF_HIDES_STRUCT = YES 469TYPEDEF_HIDES_STRUCT = YES
263 470
471# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
472# cache is used to resolve symbols given their name and scope. Since this can be
473# an expensive process and often the same symbol appears multiple times in the
474# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
475# doxygen will become slower. If the cache is too large, memory is wasted. The
476# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
477# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
478# symbols. At the end of a run doxygen will report the cache usage and suggest
479# the optimal cache size from a speed point of view.
480# Minimum value: 0, maximum value: 9, default value: 0.
481
482LOOKUP_CACHE_SIZE = 0
483
484# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
485# during processing. When set to 0 doxygen will based this on the number of
486# cores available in the system. You can set it explicitly to a value larger
487# than 0 to get more control over the balance between CPU load and processing
488# speed. At this moment only the input processing can be done using multiple
489# threads. Since this is still an experimental feature the default is set to 1,
490# which effectively disables parallel processing. Please report any issues you
491# encounter. Generating dot graphs in parallel is controlled by the
492# DOT_NUM_THREADS setting.
493# Minimum value: 0, maximum value: 32, default value: 1.
494
495NUM_PROC_THREADS = 1
496
497# If the TIMESTAMP tag is set different from NO then each generated page will
498# contain the date or date and time when the page was generated. Setting this to
499# NO can help when comparing the output of multiple runs.
500# Possible values are: YES, NO, DATETIME and DATE.
501# The default value is: NO.
502
503TIMESTAMP = YES
504
264#--------------------------------------------------------------------------- 505#---------------------------------------------------------------------------
265# Build related configuration options 506# Build related configuration options
266#--------------------------------------------------------------------------- 507#---------------------------------------------------------------------------
267 508
268# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 509# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
269# documentation are documented, even if no documentation was available. 510# documentation are documented, even if no documentation was available. Private
270# Private class members and static file members will be hidden unless 511# class members and static file members will be hidden unless the
271# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 512# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
513# Note: This will also disable the warnings about undocumented members that are
514# normally produced when WARNINGS is set to YES.
515# The default value is: NO.
272 516
273EXTRACT_ALL = NO 517EXTRACT_ALL = NO
274 518
275# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 519# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
276# will be included in the documentation. 520# be included in the documentation.
521# The default value is: NO.
277 522
278EXTRACT_PRIVATE = NO 523EXTRACT_PRIVATE = NO
279 524
280# If the EXTRACT_STATIC tag is set to YES all static members of a file 525# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
281# will be included in the documentation. 526# methods of a class will be included in the documentation.
527# The default value is: NO.
528
529EXTRACT_PRIV_VIRTUAL = NO
530
531# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
532# scope will be included in the documentation.
533# The default value is: NO.
534
535EXTRACT_PACKAGE = NO
536
537# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
538# included in the documentation.
539# The default value is: NO.
282 540
283EXTRACT_STATIC = NO 541EXTRACT_STATIC = NO
284 542
285# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 543# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
286# defined locally in source files will be included in the documentation. 544# locally in source files will be included in the documentation. If set to NO,
287# If set to NO only classes defined in header files are included. 545# only classes defined in header files are included. Does not have any effect
546# for Java sources.
547# The default value is: YES.
288 548
289EXTRACT_LOCAL_CLASSES = NO 549EXTRACT_LOCAL_CLASSES = NO
290 550
291# This flag is only useful for Objective-C code. When set to YES local 551# This flag is only useful for Objective-C code. If set to YES, local methods,
292# methods, which are defined in the implementation section but not in 552# which are defined in the implementation section but not in the interface are
293# the interface are included in the documentation. 553# included in the documentation. If set to NO, only methods in the interface are
294# If set to NO (the default) only methods in the interface are included. 554# included.
555# The default value is: NO.
295 556
296EXTRACT_LOCAL_METHODS = NO 557EXTRACT_LOCAL_METHODS = NO
297 558
298# If this flag is set to YES, the members of anonymous namespaces will be 559# If this flag is set to YES, the members of anonymous namespaces will be
299# extracted and appear in the documentation as a namespace called 560# extracted and appear in the documentation as a namespace called
300# 'anonymous_namespace{file}', where file will be replaced with the base 561# 'anonymous_namespace{file}', where file will be replaced with the base name of
301# name of the file that contains the anonymous namespace. By default 562# the file that contains the anonymous namespace. By default anonymous namespace
302# anonymous namespace are hidden. 563# are hidden.
564# The default value is: NO.
303 565
304EXTRACT_ANON_NSPACES = NO 566EXTRACT_ANON_NSPACES = NO
305 567
306# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 568# If this flag is set to YES, the name of an unnamed parameter in a declaration
307# undocumented members of documented classes, files or namespaces. 569# will be determined by the corresponding definition. By default unnamed
308# If set to NO (the default) these members will be included in the 570# parameters remain unnamed in the output.
309# various overviews, but no documentation section is generated. 571# The default value is: YES.
310# This option has no effect if EXTRACT_ALL is enabled. 572
573RESOLVE_UNNAMED_PARAMS = YES
574
575# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
576# undocumented members inside documented classes or files. If set to NO these
577# members will be included in the various overviews, but no documentation
578# section is generated. This option has no effect if EXTRACT_ALL is enabled.
579# The default value is: NO.
311 580
312HIDE_UNDOC_MEMBERS = NO 581HIDE_UNDOC_MEMBERS = NO
313 582
314# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 583# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
315# undocumented classes that are normally visible in the class hierarchy. 584# undocumented classes that are normally visible in the class hierarchy. If set
316# If set to NO (the default) these classes will be included in the various 585# to NO, these classes will be included in the various overviews. This option
317# overviews. This option has no effect if EXTRACT_ALL is enabled. 586# will also hide undocumented C++ concepts if enabled. This option has no effect
587# if EXTRACT_ALL is enabled.
588# The default value is: NO.
318 589
319HIDE_UNDOC_CLASSES = NO 590HIDE_UNDOC_CLASSES = NO
320 591
321# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 592# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
322# friend (class|struct|union) declarations. 593# declarations. If set to NO, these declarations will be included in the
323# If set to NO (the default) these declarations will be included in the
324# documentation. 594# documentation.
595# The default value is: NO.
325 596
326HIDE_FRIEND_COMPOUNDS = NO 597HIDE_FRIEND_COMPOUNDS = NO
327 598
328# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 599# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
329# documentation blocks found inside the body of a function. 600# documentation blocks found inside the body of a function. If set to NO, these
330# If set to NO (the default) these blocks will be appended to the 601# blocks will be appended to the function's detailed documentation block.
331# function's detailed documentation block. 602# The default value is: NO.
332 603
333HIDE_IN_BODY_DOCS = NO 604HIDE_IN_BODY_DOCS = NO
334 605
335# The INTERNAL_DOCS tag determines if documentation 606# The INTERNAL_DOCS tag determines if documentation that is typed after a
336# that is typed after a \internal command is included. If the tag is set 607# \internal command is included. If the tag is set to NO then the documentation
337# to NO (the default) then the documentation will be excluded. 608# will be excluded. Set it to YES to include the internal documentation.
338# Set it to YES to include the internal documentation. 609# The default value is: NO.
339 610
340INTERNAL_DOCS = NO 611INTERNAL_DOCS = NO
341 612
342# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 613# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
343# file names in lower-case letters. If set to YES upper-case letters are also 614# able to match the capabilities of the underlying filesystem. In case the
344# allowed. This is useful if you have classes or files whose names only differ 615# filesystem is case sensitive (i.e. it supports files in the same directory
345# in case and if your file system supports case sensitive file names. Windows 616# whose names only differ in casing), the option must be set to YES to properly
346# and Mac users are advised to set this option to NO. 617# deal with such files in case they appear in the input. For filesystems that
618# are not case sensitive the option should be set to NO to properly deal with
619# output files written for symbols that only differ in casing, such as for two
620# classes, one named CLASS and the other named Class, and to also support
621# references to files without having to specify the exact matching casing. On
622# Windows (including Cygwin) and MacOS, users should typically set this option
623# to NO, whereas on Linux or other Unix flavors it should typically be set to
624# YES.
625# Possible values are: SYSTEM, NO and YES.
626# The default value is: SYSTEM.
627
628CASE_SENSE_NAMES = NO
629
630# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
631# their full class and namespace scopes in the documentation. If set to YES, the
632# scope will be hidden.
633# The default value is: NO.
347 634
348CASE_SENSE_NAMES = YES 635HIDE_SCOPE_NAMES = NO
349 636
350# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 637# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
351# will show members with their full class and namespace scopes in the 638# append additional text to a page's title, such as Class Reference. If set to
352# documentation. If set to YES the scope will be hidden. 639# YES the compound reference will be hidden.
640# The default value is: NO.
353 641
354HIDE_SCOPE_NAMES = NO 642HIDE_COMPOUND_REFERENCE= NO
643
644# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
645# will show which file needs to be included to use the class.
646# The default value is: YES.
647
648SHOW_HEADERFILE = YES
355 649
356# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 650# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
357# will put a list of the files that are included by a file in the documentation 651# the files that are included by a file in the documentation of that file.
358# of that file. 652# The default value is: YES.
359 653
360SHOW_INCLUDE_FILES = YES 654SHOW_INCLUDE_FILES = NO
361 655
362# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 656# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
363# is inserted in the documentation for inline members. 657# grouped member an include statement to the documentation, telling the reader
658# which file to include in order to use the member.
659# The default value is: NO.
660
661SHOW_GROUPED_MEMB_INC = NO
662
663# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
664# files with double quotes in the documentation rather than with sharp brackets.
665# The default value is: NO.
666
667FORCE_LOCAL_INCLUDES = NO
668
669# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
670# documentation for inline members.
671# The default value is: YES.
364 672
365INLINE_INFO = YES 673INLINE_INFO = YES
366 674
367# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 675# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
368# will sort the (detailed) documentation of file and class members 676# (detailed) documentation of file and class members alphabetically by member
369# alphabetically by member name. If set to NO the members will appear in 677# name. If set to NO, the members will appear in declaration order.
370# declaration order. 678# The default value is: YES.
371 679
372SORT_MEMBER_DOCS = YES 680SORT_MEMBER_DOCS = YES
373 681
374# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 682# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
375# brief documentation of file, namespace and class members alphabetically 683# descriptions of file, namespace and class members alphabetically by member
376# by member name. If set to NO (the default) the members will appear in 684# name. If set to NO, the members will appear in declaration order. Note that
377# declaration order. 685# this will also influence the order of the classes in the class list.
686# The default value is: NO.
378 687
379SORT_BRIEF_DOCS = NO 688SORT_BRIEF_DOCS = NO
380 689
381# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 690# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
382# hierarchy of group names into alphabetical order. If set to NO (the default) 691# (brief and detailed) documentation of class members so that constructors and
383# the group names will appear in their defined order. 692# destructors are listed first. If set to NO the constructors will appear in the
693# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
694# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
695# member documentation.
696# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
697# detailed member documentation.
698# The default value is: NO.
699
700SORT_MEMBERS_CTORS_1ST = NO
701
702# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
703# of group names into alphabetical order. If set to NO the group names will
704# appear in their defined order.
705# The default value is: NO.
384 706
385SORT_GROUP_NAMES = NO 707SORT_GROUP_NAMES = NO
386 708
387# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 709# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
388# sorted by fully-qualified names, including namespaces. If set to 710# fully-qualified names, including namespaces. If set to NO, the class list will
389# NO (the default), the class list will be sorted only by class name, 711# be sorted only by class name, not including the namespace part.
390# not including the namespace part.
391# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 712# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
392# Note: This option applies only to the class list, not to the 713# Note: This option applies only to the class list, not to the alphabetical
393# alphabetical list. 714# list.
715# The default value is: NO.
394 716
395SORT_BY_SCOPE_NAME = NO 717SORT_BY_SCOPE_NAME = NO
396 718
397# The GENERATE_TODOLIST tag can be used to enable (YES) or 719# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
398# disable (NO) the todo list. This list is created by putting \todo 720# type resolution of all parameters of a function it will reject a match between
399# commands in the documentation. 721# the prototype and the implementation of a member function even if there is
722# only one candidate or it is obvious which candidate to choose by doing a
723# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
724# accept a match between prototype and implementation in such cases.
725# The default value is: NO.
726
727STRICT_PROTO_MATCHING = NO
728
729# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
730# list. This list is created by putting \todo commands in the documentation.
731# The default value is: YES.
400 732
401GENERATE_TODOLIST = YES 733GENERATE_TODOLIST = YES
402 734
403# The GENERATE_TESTLIST tag can be used to enable (YES) or 735# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
404# disable (NO) the test list. This list is created by putting \test 736# list. This list is created by putting \test commands in the documentation.
405# commands in the documentation. 737# The default value is: YES.
406 738
407GENERATE_TESTLIST = YES 739GENERATE_TESTLIST = YES
408 740
409# The GENERATE_BUGLIST tag can be used to enable (YES) or 741# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
410# disable (NO) the bug list. This list is created by putting \bug 742# list. This list is created by putting \bug commands in the documentation.
411# commands in the documentation. 743# The default value is: YES.
412 744
413GENERATE_BUGLIST = YES 745GENERATE_BUGLIST = YES
414 746
415# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 747# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
416# disable (NO) the deprecated list. This list is created by putting 748# the deprecated list. This list is created by putting \deprecated commands in
417# \deprecated commands in the documentation. 749# the documentation.
750# The default value is: YES.
418 751
419GENERATE_DEPRECATEDLIST= YES 752GENERATE_DEPRECATEDLIST= YES
420 753
421# The ENABLED_SECTIONS tag can be used to enable conditional 754# The ENABLED_SECTIONS tag can be used to enable conditional documentation
422# documentation sections, marked by \if sectionname ... \endif. 755# sections, marked by \if <section_label> ... \endif and \cond <section_label>
756# ... \endcond blocks.
423 757
424ENABLED_SECTIONS = 758ENABLED_SECTIONS =
425 759
426# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 760# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
427# the initial value of a variable or define consists of for it to appear in 761# initial value of a variable or macro / define can have for it to appear in the
428# the documentation. If the initializer consists of more lines than specified 762# documentation. If the initializer consists of more lines than specified here
429# here it will be hidden. Use a value of 0 to hide initializers completely. 763# it will be hidden. Use a value of 0 to hide initializers completely. The
430# The appearance of the initializer of individual variables and defines in the 764# appearance of the value of individual variables and macros / defines can be
431# documentation can be controlled using \showinitializer or \hideinitializer 765# controlled using \showinitializer or \hideinitializer command in the
432# command in the documentation regardless of this setting. 766# documentation regardless of this setting.
767# Minimum value: 0, maximum value: 10000, default value: 30.
433 768
434MAX_INITIALIZER_LINES = 30 769MAX_INITIALIZER_LINES = 30
435 770
436# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 771# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
437# at the bottom of the documentation of classes and structs. If set to YES the 772# the bottom of the documentation of classes and structs. If set to YES, the
438# list will mention the files that were used to generate the documentation. 773# list will mention the files that were used to generate the documentation.
774# The default value is: YES.
439 775
440SHOW_USED_FILES = YES 776SHOW_USED_FILES = NO
441 777
442# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 778# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
443# This will remove the Files entry from the Quick Index and from the 779# will remove the Files entry from the Quick Index and from the Folder Tree View
444# Folder Tree View (if specified). The default is YES. 780# (if specified).
781# The default value is: YES.
445 782
446SHOW_FILES = YES 783SHOW_FILES = YES
447 784
448# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 785# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
449# Namespaces page. This will remove the Namespaces entry from the Quick Index 786# page. This will remove the Namespaces entry from the Quick Index and from the
450# and from the Folder Tree View (if specified). The default is YES. 787# Folder Tree View (if specified).
788# The default value is: YES.
451 789
452SHOW_NAMESPACES = YES 790SHOW_NAMESPACES = YES
453 791
454# The FILE_VERSION_FILTER tag can be used to specify a program or script that 792# The FILE_VERSION_FILTER tag can be used to specify a program or script that
455# doxygen should invoke to get the current version for each file (typically from 793# doxygen should invoke to get the current version for each file (typically from
456# the version control system). Doxygen will invoke the program by executing (via 794# the version control system). Doxygen will invoke the program by executing (via
457# popen()) the command <command> <input-file>, where <command> is the value of 795# popen()) the command command input-file, where command is the value of the
458# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 796# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
459# provided by doxygen. Whatever the program writes to standard output 797# by doxygen. Whatever the program writes to standard output is used as the file
460# is used as the file version. See the manual for examples. 798# version. For an example see the documentation.
799
800FILE_VERSION_FILTER =
801
802# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
803# by doxygen. The layout file controls the global structure of the generated
804# output files in an output format independent way. To create the layout file
805# that represents doxygen's defaults, run doxygen with the -l option. You can
806# optionally specify a file name after the option, if omitted DoxygenLayout.xml
807# will be used as the name of the layout file. See also section "Changing the
808# layout of pages" for information.
809#
810# Note that if you run doxygen from a directory containing a file called
811# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
812# tag is left empty.
813
814LAYOUT_FILE = docs/doxygen/layout.xml
815
816# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
817# the reference definitions. This must be a list of .bib files. The .bib
818# extension is automatically appended if omitted. This requires the bibtex tool
819# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
820# For LaTeX the style of the bibliography can be controlled using
821# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
822# search path. See also \cite for info how to create references.
461 823
462FILE_VERSION_FILTER = 824CITE_BIB_FILES =
463 825
464#--------------------------------------------------------------------------- 826#---------------------------------------------------------------------------
465# configuration options related to warning and progress messages 827# Configuration options related to warning and progress messages
466#--------------------------------------------------------------------------- 828#---------------------------------------------------------------------------
467 829
468# The QUIET tag can be used to turn on/off the messages that are generated 830# The QUIET tag can be used to turn on/off the messages that are generated to
469# by doxygen. Possible values are YES and NO. If left blank NO is used. 831# standard output by doxygen. If QUIET is set to YES this implies that the
832# messages are off.
833# The default value is: NO.
470 834
471QUIET = NO 835QUIET = NO
472 836
473# The WARNINGS tag can be used to turn on/off the warning messages that are 837# The WARNINGS tag can be used to turn on/off the warning messages that are
474# generated by doxygen. Possible values are YES and NO. If left blank 838# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
475# NO is used. 839# this implies that the warnings are on.
840#
841# Tip: Turn warnings on while writing the documentation.
842# The default value is: YES.
476 843
477WARNINGS = YES 844WARNINGS = YES
478 845
479# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 846# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
480# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 847# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
481# automatically be disabled. 848# will automatically be disabled.
849# The default value is: YES.
482 850
483WARN_IF_UNDOCUMENTED = YES 851WARN_IF_UNDOCUMENTED = YES
484 852
485# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 853# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
486# potential errors in the documentation, such as not documenting some 854# potential errors in the documentation, such as documenting some parameters in
487# parameters in a documented function, or documenting parameters that 855# a documented function twice, or documenting parameters that don't exist or
488# don't exist or using markup commands wrongly. 856# using markup commands wrongly.
857# The default value is: YES.
489 858
490WARN_IF_DOC_ERROR = YES 859WARN_IF_DOC_ERROR = YES
491 860
492# This WARN_NO_PARAMDOC option can be abled to get warnings for 861# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
493# functions that are documented, but have no documentation for their parameters 862# function parameter documentation. If set to NO, doxygen will accept that some
494# or return value. If set to NO (the default) doxygen will only warn about 863# parameters have no documentation without warning.
495# wrong or incomplete parameter documentation, but not about the absence of 864# The default value is: YES.
496# documentation. 865
866WARN_IF_INCOMPLETE_DOC = YES
867
868# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
869# are documented, but have no documentation for their parameters or return
870# value. If set to NO, doxygen will only warn about wrong parameter
871# documentation, but not about the absence of documentation. If EXTRACT_ALL is
872# set to YES then this flag will automatically be disabled. See also
873# WARN_IF_INCOMPLETE_DOC
874# The default value is: NO.
497 875
498WARN_NO_PARAMDOC = NO 876WARN_NO_PARAMDOC = NO
499 877
500# The WARN_FORMAT tag determines the format of the warning messages that 878# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
501# doxygen can produce. The string should contain the $file, $line, and $text 879# undocumented enumeration values. If set to NO, doxygen will accept
502# tags, which will be replaced by the file and line number from which the 880# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
503# warning originated and the warning text. Optionally the format may contain 881# will automatically be disabled.
504# $version, which will be replaced by the version of the file (if it could 882# The default value is: NO.
505# be obtained via FILE_VERSION_FILTER) 883
884WARN_IF_UNDOC_ENUM_VAL = NO
885
886# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
887# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
888# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
889# at the end of the doxygen process doxygen will return with a non-zero status.
890# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves
891# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not
892# write the warning messages in between other messages but write them at the end
893# of a run, in case a WARN_LOGFILE is defined the warning messages will be
894# besides being in the defined file also be shown at the end of a run, unless
895# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
896# the behavior will remain as with the setting FAIL_ON_WARNINGS.
897# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
898# The default value is: NO.
899
900WARN_AS_ERROR = NO
901
902# The WARN_FORMAT tag determines the format of the warning messages that doxygen
903# can produce. The string should contain the $file, $line, and $text tags, which
904# will be replaced by the file and line number from which the warning originated
905# and the warning text. Optionally the format may contain $version, which will
906# be replaced by the version of the file (if it could be obtained via
907# FILE_VERSION_FILTER)
908# See also: WARN_LINE_FORMAT
909# The default value is: $file:$line: $text.
506 910
507WARN_FORMAT = "$file:$line: $text" 911WARN_FORMAT = "$file:$line: $text"
508 912
509# The WARN_LOGFILE tag can be used to specify a file to which warning 913# In the $text part of the WARN_FORMAT command it is possible that a reference
510# and error messages should be written. If left blank the output is written 914# to a more specific place is given. To make it easier to jump to this place
511# to stderr. 915# (outside of doxygen) the user can define a custom "cut" / "paste" string.
916# Example:
917# WARN_LINE_FORMAT = "'vi $file +$line'"
918# See also: WARN_FORMAT
919# The default value is: at line $line of file $file.
920
921WARN_LINE_FORMAT = "at line $line of file $file"
922
923# The WARN_LOGFILE tag can be used to specify a file to which warning and error
924# messages should be written. If left blank the output is written to standard
925# error (stderr). In case the file specified cannot be opened for writing the
926# warning and error messages are written to standard error. When as file - is
927# specified the warning and error messages are written to standard output
928# (stdout).
512 929
513WARN_LOGFILE = 930WARN_LOGFILE =
514 931
515#--------------------------------------------------------------------------- 932#---------------------------------------------------------------------------
516# configuration options related to the input files 933# Configuration options related to the input files
517#--------------------------------------------------------------------------- 934#---------------------------------------------------------------------------
518 935
519# The INPUT tag can be used to specify the files and/or directories that contain 936# The INPUT tag is used to specify the files and/or directories that contain
520# documented source files. You may enter file names like "myfile.cpp" or 937# documented source files. You may enter file names like myfile.cpp or
521# directories like "/usr/src/myproject". Separate the files or directories 938# directories like /usr/src/myproject. Separate the files or directories with
522# with spaces. 939# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
940# Note: If this tag is empty the current directory is searched.
523 941
524INPUT = include/plist/plist.h \ 942INPUT = include/plist/plist.h \
525 docs/README.doxygen.md 943 docs/README.doxygen.md
526 944
527# This tag can be used to specify the character encoding of the source files 945# This tag can be used to specify the character encoding of the source files
528# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 946# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
529# also the default input encoding. Doxygen uses libiconv (or the iconv built 947# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
530# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 948# documentation (see:
531# the list of possible encodings. 949# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
950# See also: INPUT_FILE_ENCODING
951# The default value is: UTF-8.
532 952
533INPUT_ENCODING = UTF-8 953INPUT_ENCODING = UTF-8
534 954
535# If the value of the INPUT tag contains directories, you can use the 955# This tag can be used to specify the character encoding of the source files
536# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 956# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
537# and *.h) to filter out the source-files in the directories. If left 957# character encoding on a per file pattern basis. Doxygen will compare the file
538# blank the following patterns are tested: 958# name with each pattern and apply the encoding instead of the default
539# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 959# INPUT_ENCODING) if there is a match. The character encodings are a list of the
540# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 960# form: pattern=encoding (like *.php=ISO-8859-1).
961# See also: INPUT_ENCODING for further information on supported encodings.
962
963INPUT_FILE_ENCODING =
964
965# If the value of the INPUT tag contains directories, you can use the
966# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
967# *.h) to filter out the source-files in the directories.
968#
969# Note that for custom extensions or not directly supported extensions you also
970# need to set EXTENSION_MAPPING for the extension otherwise the files are not
971# read by doxygen.
972#
973# Note the list of default checked file patterns might differ from the list of
974# default file extension mappings.
975#
976# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
977# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl,
978# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d,
979# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to
980# be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
981# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
541 982
542FILE_PATTERNS = 983FILE_PATTERNS =
543 984
544# The RECURSIVE tag can be used to turn specify whether or not subdirectories 985# The RECURSIVE tag can be used to specify whether or not subdirectories should
545# should be searched for input files as well. Possible values are YES and NO. 986# be searched for input files as well.
546# If left blank NO is used. 987# The default value is: NO.
547 988
548RECURSIVE = NO 989RECURSIVE = NO
549 990
550# The EXCLUDE tag can be used to specify files and/or directories that should 991# The EXCLUDE tag can be used to specify files and/or directories that should be
551# excluded from the INPUT source files. This way you can easily exclude a 992# excluded from the INPUT source files. This way you can easily exclude a
552# subdirectory from a directory tree whose root is specified with the INPUT tag. 993# subdirectory from a directory tree whose root is specified with the INPUT tag.
994#
995# Note that relative paths are relative to the directory from which doxygen is
996# run.
553 997
554EXCLUDE = dev 998EXCLUDE =
555 999
556# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 1000# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
557# directories that are symbolic links (a Unix filesystem feature) are excluded 1001# directories that are symbolic links (a Unix file system feature) are excluded
558# from the input. 1002# from the input.
1003# The default value is: NO.
559 1004
560EXCLUDE_SYMLINKS = NO 1005EXCLUDE_SYMLINKS = NO
561 1006
562# If the value of the INPUT tag contains directories, you can use the 1007# If the value of the INPUT tag contains directories, you can use the
563# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 1008# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
564# certain files from those directories. Note that the wildcards are matched 1009# certain files from those directories.
565# against the file with absolute path, so to exclude all test directories 1010#
566# for example use the pattern */test/* 1011# Note that the wildcards are matched against the file with absolute path, so to
1012# exclude all test directories for example use the pattern */test/*
567 1013
568EXCLUDE_PATTERNS = 1014EXCLUDE_PATTERNS =
569 1015
570# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 1016# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
571# (namespaces, classes, functions, etc.) that should be excluded from the 1017# (namespaces, classes, functions, etc.) that should be excluded from the
572# output. The symbol name can be a fully qualified name, a word, or if the 1018# output. The symbol name can be a fully qualified name, a word, or if the
573# wildcard * is used, a substring. Examples: ANamespace, AClass, 1019# wildcard * is used, a substring. Examples: ANamespace, AClass,
574# AClass::ANamespace, ANamespace::*Test 1020# ANamespace::AClass, ANamespace::*Test
575 1021
576EXCLUDE_SYMBOLS = PLIST_WARN_DEPRECATED PLIST_API PLIST_UINT PLIST_IS_UINT 1022EXCLUDE_SYMBOLS = PLIST_WARN_DEPRECATED PLIST_API PLIST_UINT PLIST_IS_UINT
577 1023
578# The EXAMPLE_PATH tag can be used to specify one or more files or 1024# The EXAMPLE_PATH tag can be used to specify one or more files or directories
579# directories that contain example code fragments that are included (see 1025# that contain example code fragments that are included (see the \include
580# the \include command). 1026# command).
581 1027
582EXAMPLE_PATH = 1028EXAMPLE_PATH =
583 1029
584# If the value of the EXAMPLE_PATH tag contains directories, you can use the 1030# If the value of the EXAMPLE_PATH tag contains directories, you can use the
585# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 1031# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
586# and *.h) to filter out the source-files in the directories. If left 1032# *.h) to filter out the source-files in the directories. If left blank all
587# blank all files are included. 1033# files are included.
588 1034
589EXAMPLE_PATTERNS = 1035EXAMPLE_PATTERNS =
590 1036
591# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 1037# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
592# searched for input files to be used with the \include or \dontinclude 1038# searched for input files to be used with the \include or \dontinclude commands
593# commands irrespective of the value of the RECURSIVE tag. 1039# irrespective of the value of the RECURSIVE tag.
594# Possible values are YES and NO. If left blank NO is used. 1040# The default value is: NO.
595 1041
596EXAMPLE_RECURSIVE = NO 1042EXAMPLE_RECURSIVE = NO
597 1043
598# The IMAGE_PATH tag can be used to specify one or more files or 1044# The IMAGE_PATH tag can be used to specify one or more files or directories
599# directories that contain image that are included in the documentation (see 1045# that contain images that are to be included in the documentation (see the
600# the \image command). 1046# \image command).
601 1047
602IMAGE_PATH = 1048IMAGE_PATH =
603 1049
604# The INPUT_FILTER tag can be used to specify a program that doxygen should 1050# The INPUT_FILTER tag can be used to specify a program that doxygen should
605# invoke to filter for each input file. Doxygen will invoke the filter program 1051# invoke to filter for each input file. Doxygen will invoke the filter program
606# by executing (via popen()) the command <filter> <input-file>, where <filter> 1052# by executing (via popen()) the command:
607# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 1053#
608# input file. Doxygen will then use the output that the filter program writes 1054# <filter> <input-file>
609# to standard output. If FILTER_PATTERNS is specified, this tag will be 1055#
610# ignored. 1056# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1057# name of an input file. Doxygen will then use the output that the filter
1058# program writes to standard output. If FILTER_PATTERNS is specified, this tag
1059# will be ignored.
1060#
1061# Note that the filter must not add or remove lines; it is applied before the
1062# code is scanned, but not when the output code is generated. If lines are added
1063# or removed, the anchors will not be placed correctly.
1064#
1065# Note that doxygen will use the data processed and written to standard output
1066# for further processing, therefore nothing else, like debug statements or used
1067# commands (so in case of a Windows batch file always use @echo OFF), should be
1068# written to standard output.
1069#
1070# Note that for custom extensions or not directly supported extensions you also
1071# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1072# properly processed by doxygen.
1073
1074INPUT_FILTER =
1075
1076# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1077# basis. Doxygen will compare the file name with each pattern and apply the
1078# filter if there is a match. The filters are a list of the form: pattern=filter
1079# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1080# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1081# patterns match the file name, INPUT_FILTER is applied.
1082#
1083# Note that for custom extensions or not directly supported extensions you also
1084# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1085# properly processed by doxygen.
611 1086
612INPUT_FILTER = 1087FILTER_PATTERNS =
613 1088
614# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 1089# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
615# basis. Doxygen will compare the file name with each pattern and apply the 1090# INPUT_FILTER) will also be used to filter the input files that are used for
616# filter if there is a match. The filters are a list of the form: 1091# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
617# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 1092# The default value is: NO.
618# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
619# is applied to all files.
620 1093
621FILTER_PATTERNS = 1094FILTER_SOURCE_FILES = NO
622 1095
623# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 1096# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
624# INPUT_FILTER) will be used to filter the input files when producing source 1097# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
625# files to browse (i.e. when SOURCE_BROWSER is set to YES). 1098# it is also possible to disable source filtering for a specific pattern using
1099# *.ext= (so without naming a filter).
1100# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
626 1101
627FILTER_SOURCE_FILES = NO 1102FILTER_SOURCE_PATTERNS =
628 1103
629# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 1104# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
630# is part of the input, its contents will be placed on the main page 1105# is part of the input, its contents will be placed on the main page
@@ -633,720 +1108,1699 @@ FILTER_SOURCE_FILES = NO
633 1108
634USE_MDFILE_AS_MAINPAGE = docs/README.doxygen.md 1109USE_MDFILE_AS_MAINPAGE = docs/README.doxygen.md
635 1110
1111# The Fortran standard specifies that for fixed formatted Fortran code all
1112# characters from position 72 are to be considered as comment. A common
1113# extension is to allow longer lines before the automatic comment starts. The
1114# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1115# be processed before the automatic comment starts.
1116# Minimum value: 7, maximum value: 10000, default value: 72.
1117
1118FORTRAN_COMMENT_AFTER = 72
1119
636#--------------------------------------------------------------------------- 1120#---------------------------------------------------------------------------
637# configuration options related to source browsing 1121# Configuration options related to source browsing
638#--------------------------------------------------------------------------- 1122#---------------------------------------------------------------------------
639 1123
640# If the SOURCE_BROWSER tag is set to YES then a list of source files will 1124# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
641# be generated. Documented entities will be cross-referenced with these sources. 1125# generated. Documented entities will be cross-referenced with these sources.
642# Note: To get rid of all source code in the generated output, make sure also 1126#
643# VERBATIM_HEADERS is set to NO. 1127# Note: To get rid of all source code in the generated output, make sure that
1128# also VERBATIM_HEADERS is set to NO.
1129# The default value is: NO.
644 1130
645SOURCE_BROWSER = NO 1131SOURCE_BROWSER = NO
646 1132
647# Setting the INLINE_SOURCES tag to YES will include the body 1133# Setting the INLINE_SOURCES tag to YES will include the body of functions,
648# of functions and classes directly in the documentation. 1134# multi-line macros, enums or list initialized variables directly into the
1135# documentation.
1136# The default value is: NO.
649 1137
650INLINE_SOURCES = NO 1138INLINE_SOURCES = NO
651 1139
652# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 1140# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
653# doxygen to hide any special comment blocks from generated source code 1141# special comment blocks from generated source code fragments. Normal C, C++ and
654# fragments. Normal C and C++ comments will always remain visible. 1142# Fortran comments will always remain visible.
1143# The default value is: YES.
655 1144
656STRIP_CODE_COMMENTS = YES 1145STRIP_CODE_COMMENTS = YES
657 1146
658# If the REFERENCED_BY_RELATION tag is set to YES 1147# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
659# then for each documented function all documented 1148# entity all documented functions referencing it will be listed.
660# functions referencing it will be listed. 1149# The default value is: NO.
661 1150
662REFERENCED_BY_RELATION = YES 1151REFERENCED_BY_RELATION = YES
663 1152
664# If the REFERENCES_RELATION tag is set to YES 1153# If the REFERENCES_RELATION tag is set to YES then for each documented function
665# then for each documented function all documented entities 1154# all documented entities called/used by that function will be listed.
666# called/used by that function will be listed. 1155# The default value is: NO.
667 1156
668REFERENCES_RELATION = YES 1157REFERENCES_RELATION = YES
669 1158
670# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 1159# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
671# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 1160# to YES then the hyperlinks from functions in REFERENCES_RELATION and
672# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 1161# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
673# link to the source code. Otherwise they will link to the documentstion. 1162# link to the documentation.
1163# The default value is: YES.
674 1164
675REFERENCES_LINK_SOURCE = YES 1165REFERENCES_LINK_SOURCE = YES
676 1166
677# If the USE_HTAGS tag is set to YES then the references to source code 1167# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
678# will point to the HTML generated by the htags(1) tool instead of doxygen 1168# source code will show a tooltip with additional information such as prototype,
679# built-in source browser. The htags tool is part of GNU's global source 1169# brief description and links to the definition and documentation. Since this
680# tagging system (see http://www.gnu.org/software/global/global.html). You 1170# will make the HTML file larger and loading of large files a bit slower, you
681# will need version 4.8.6 or higher. 1171# can opt to disable this feature.
1172# The default value is: YES.
1173# This tag requires that the tag SOURCE_BROWSER is set to YES.
1174
1175SOURCE_TOOLTIPS = YES
1176
1177# If the USE_HTAGS tag is set to YES then the references to source code will
1178# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1179# source browser. The htags tool is part of GNU's global source tagging system
1180# (see https://www.gnu.org/software/global/global.html). You will need version
1181# 4.8.6 or higher.
1182#
1183# To use it do the following:
1184# - Install the latest version of global
1185# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1186# - Make sure the INPUT points to the root of the source tree
1187# - Run doxygen as normal
1188#
1189# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1190# tools must be available from the command line (i.e. in the search path).
1191#
1192# The result: instead of the source browser generated by doxygen, the links to
1193# source code will now point to the output of htags.
1194# The default value is: NO.
1195# This tag requires that the tag SOURCE_BROWSER is set to YES.
682 1196
683USE_HTAGS = NO 1197USE_HTAGS = NO
684 1198
685# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 1199# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
686# will generate a verbatim copy of the header file for each class for 1200# verbatim copy of the header file for each class for which an include is
687# which an include is specified. Set to NO to disable this. 1201# specified. Set to NO to disable this.
1202# See also: Section \class.
1203# The default value is: YES.
688 1204
689VERBATIM_HEADERS = NO 1205VERBATIM_HEADERS = NO
690 1206
691#--------------------------------------------------------------------------- 1207#---------------------------------------------------------------------------
692# configuration options related to the alphabetical class index 1208# Configuration options related to the alphabetical class index
693#--------------------------------------------------------------------------- 1209#---------------------------------------------------------------------------
694 1210
695# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 1211# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
696# of all compounds will be generated. Enable this if the project 1212# compounds will be generated. Enable this if the project contains a lot of
697# contains a lot of classes, structs, unions or interfaces. 1213# classes, structs, unions or interfaces.
1214# The default value is: YES.
698 1215
699ALPHABETICAL_INDEX = NO 1216ALPHABETICAL_INDEX = NO
700 1217
701# In case all classes in a project start with a common prefix, all 1218# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
702# classes will be put under the same header in the alphabetical index. 1219# that should be ignored while generating the index headers. The IGNORE_PREFIX
703# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 1220# tag works for classes, function and member names. The entity will be placed in
704# should be ignored while generating the index headers. 1221# the alphabetical list under the first letter of the entity name that remains
1222# after removing the prefix.
1223# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
705 1224
706IGNORE_PREFIX = 1225IGNORE_PREFIX =
707 1226
708#--------------------------------------------------------------------------- 1227#---------------------------------------------------------------------------
709# configuration options related to the HTML output 1228# Configuration options related to the HTML output
710#--------------------------------------------------------------------------- 1229#---------------------------------------------------------------------------
711 1230
712# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 1231# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
713# generate HTML output. 1232# The default value is: YES.
714 1233
715GENERATE_HTML = YES 1234GENERATE_HTML = YES
716 1235
717# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 1236# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
718# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1237# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
719# put in front of it. If left blank `html' will be used as the default path. 1238# it.
1239# The default directory is: html.
1240# This tag requires that the tag GENERATE_HTML is set to YES.
720 1241
721HTML_OUTPUT = html 1242HTML_OUTPUT = html
722 1243
723# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 1244# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
724# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 1245# generated HTML page (for example: .htm, .php, .asp).
725# doxygen will generate files with .html extension. 1246# The default value is: .html.
1247# This tag requires that the tag GENERATE_HTML is set to YES.
726 1248
727HTML_FILE_EXTENSION = .html 1249HTML_FILE_EXTENSION = .html
728 1250
729# The HTML_HEADER tag can be used to specify a personal HTML header for 1251# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
730# each generated HTML page. If it is left blank doxygen will generate a 1252# each generated HTML page. If the tag is left blank doxygen will generate a
731# standard header. 1253# standard header.
1254#
1255# To get valid HTML the header file that includes any scripts and style sheets
1256# that doxygen needs, which is dependent on the configuration options used (e.g.
1257# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1258# default header using
1259# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1260# YourConfigFile
1261# and then modify the file new_header.html. See also section "Doxygen usage"
1262# for information on how to generate the default header that doxygen normally
1263# uses.
1264# Note: The header is subject to change so you typically have to regenerate the
1265# default header when upgrading to a newer version of doxygen. For a description
1266# of the possible markers and block names see the documentation.
1267# This tag requires that the tag GENERATE_HTML is set to YES.
1268
1269HTML_HEADER = docs/doxygen/header.html
1270
1271# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1272# generated HTML page. If the tag is left blank doxygen will generate a standard
1273# footer. See HTML_HEADER for more information on how to generate a default
1274# footer and what special commands can be used inside the footer. See also
1275# section "Doxygen usage" for information on how to generate the default footer
1276# that doxygen normally uses.
1277# This tag requires that the tag GENERATE_HTML is set to YES.
1278
1279HTML_FOOTER = docs/doxygen/footer.html
1280
1281# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1282# sheet that is used by each HTML page. It can be used to fine-tune the look of
1283# the HTML output. If left blank doxygen will generate a default style sheet.
1284# See also section "Doxygen usage" for information on how to generate the style
1285# sheet that doxygen normally uses.
1286# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1287# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1288# obsolete.
1289# This tag requires that the tag GENERATE_HTML is set to YES.
1290
1291HTML_STYLESHEET =
1292
1293# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1294# cascading style sheets that are included after the standard style sheets
1295# created by doxygen. Using this option one can overrule certain style aspects.
1296# This is preferred over using HTML_STYLESHEET since it does not replace the
1297# standard style sheet and is therefore more robust against future updates.
1298# Doxygen will copy the style sheet files to the output directory.
1299# Note: The order of the extra style sheet files is of importance (e.g. the last
1300# style sheet in the list overrules the setting of the previous ones in the
1301# list).
1302# Note: Since the styling of scrollbars can currently not be overruled in
1303# Webkit/Chromium, the styling will be left out of the default doxygen.css if
1304# one or more extra stylesheets have been specified. So if scrollbar
1305# customization is desired it has to be added explicitly. For an example see the
1306# documentation.
1307# This tag requires that the tag GENERATE_HTML is set to YES.
1308
1309HTML_EXTRA_STYLESHEET = docs/doxygen/custom.css
1310
1311# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1312# other source files which should be copied to the HTML output directory. Note
1313# that these files will be copied to the base HTML output directory. Use the
1314# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1315# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1316# files will be copied as-is; there are no commands or markers available.
1317# This tag requires that the tag GENERATE_HTML is set to YES.
1318
1319HTML_EXTRA_FILES = docs/doxygen/favicon.ico \
1320 docs/doxygen/folder.png \
1321 docs/doxygen/folder-open.png \
1322 docs/doxygen/text-x-generic.png
1323
1324# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1325# should be rendered with a dark or light theme.
1326# Possible values are: LIGHT always generates light mode output, DARK always
1327# generates dark mode output, AUTO_LIGHT automatically sets the mode according
1328# to the user preference, uses light mode if no preference is set (the default),
1329# AUTO_DARK automatically sets the mode according to the user preference, uses
1330# dark mode if no preference is set and TOGGLE allows a user to switch between
1331# light and dark mode via a button.
1332# The default value is: AUTO_LIGHT.
1333# This tag requires that the tag GENERATE_HTML is set to YES.
1334
1335HTML_COLORSTYLE = AUTO_LIGHT
1336
1337# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1338# will adjust the colors in the style sheet and background images according to
1339# this color. Hue is specified as an angle on a color-wheel, see
1340# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1341# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1342# purple, and 360 is red again.
1343# Minimum value: 0, maximum value: 359, default value: 220.
1344# This tag requires that the tag GENERATE_HTML is set to YES.
1345
1346HTML_COLORSTYLE_HUE = 220
1347
1348# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1349# in the HTML output. For a value of 0 the output will use gray-scales only. A
1350# value of 255 will produce the most vivid colors.
1351# Minimum value: 0, maximum value: 255, default value: 100.
1352# This tag requires that the tag GENERATE_HTML is set to YES.
1353
1354HTML_COLORSTYLE_SAT = 100
1355
1356# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1357# luminance component of the colors in the HTML output. Values below 100
1358# gradually make the output lighter, whereas values above 100 make the output
1359# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1360# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1361# change the gamma.
1362# Minimum value: 40, maximum value: 240, default value: 80.
1363# This tag requires that the tag GENERATE_HTML is set to YES.
1364
1365HTML_COLORSTYLE_GAMMA = 80
1366
1367# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1368# documentation will contain a main index with vertical navigation menus that
1369# are dynamically created via JavaScript. If disabled, the navigation index will
1370# consists of multiple levels of tabs that are statically embedded in every HTML
1371# page. Disable this option to support browsers that do not have JavaScript,
1372# like the Qt help browser.
1373# The default value is: YES.
1374# This tag requires that the tag GENERATE_HTML is set to YES.
1375
1376HTML_DYNAMIC_MENUS = NO
1377
1378# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1379# documentation will contain sections that can be hidden and shown after the
1380# page has loaded.
1381# The default value is: NO.
1382# This tag requires that the tag GENERATE_HTML is set to YES.
732 1383
733HTML_HEADER = 1384HTML_DYNAMIC_SECTIONS = NO
734
735# The HTML_FOOTER tag can be used to specify a personal HTML footer for
736# each generated HTML page. If it is left blank doxygen will generate a
737# standard footer.
738
739HTML_FOOTER =
740
741# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
742# style sheet that is used by each HTML page. It can be used to
743# fine-tune the look of the HTML output. If the tag is left blank doxygen
744# will generate a default style sheet. Note that doxygen will try to copy
745# the style sheet file to the HTML output directory, so don't put your own
746# stylesheet in the HTML output directory as well, or it will be erased!
747
748HTML_STYLESHEET =
749
750# If the GENERATE_HTMLHELP tag is set to YES, additional index files
751# will be generated that can be used as input for tools like the
752# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
753# of the generated HTML documentation.
754
755GENERATE_HTMLHELP = NO
756 1385
757# If the GENERATE_DOCSET tag is set to YES, additional index files 1386# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
758# will be generated that can be used as input for Apple's Xcode 3 1387# dynamically folded and expanded in the generated HTML source code.
759# integrated development environment, introduced with OSX 10.5 (Leopard). 1388# The default value is: YES.
760# To create a documentation set, doxygen will generate a Makefile in the 1389# This tag requires that the tag GENERATE_HTML is set to YES.
761# HTML output directory. Running make will produce the docset in that 1390
762# directory and running "make install" will install the docset in 1391HTML_CODE_FOLDING = YES
763# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 1392
764# it at startup. 1393# If the HTML_COPY_CLIPBOARD tag is set to YES then doxygen will show an icon in
1394# the top right corner of code and text fragments that allows the user to copy
1395# its content to the clipboard. Note this only works if supported by the browser
1396# and the web page is served via a secure context (see:
1397# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file:
1398# protocol.
1399# The default value is: YES.
1400# This tag requires that the tag GENERATE_HTML is set to YES.
1401
1402HTML_COPY_CLIPBOARD = YES
1403
1404# Doxygen stores a couple of settings persistently in the browser (via e.g.
1405# cookies). By default these settings apply to all HTML pages generated by
1406# doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store
1407# the settings under a project specific key, such that the user preferences will
1408# be stored separately.
1409# This tag requires that the tag GENERATE_HTML is set to YES.
1410
1411HTML_PROJECT_COOKIE =
1412
1413# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1414# shown in the various tree structured indices initially; the user can expand
1415# and collapse entries dynamically later on. Doxygen will expand the tree to
1416# such a level that at most the specified number of entries are visible (unless
1417# a fully collapsed tree already exceeds this amount). So setting the number of
1418# entries 1 will produce a full collapsed tree by default. 0 is a special value
1419# representing an infinite number of entries and will result in a full expanded
1420# tree by default.
1421# Minimum value: 0, maximum value: 9999, default value: 100.
1422# This tag requires that the tag GENERATE_HTML is set to YES.
1423
1424HTML_INDEX_NUM_ENTRIES = 100
1425
1426# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1427# generated that can be used as input for Apple's Xcode 3 integrated development
1428# environment (see:
1429# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1430# create a documentation set, doxygen will generate a Makefile in the HTML
1431# output directory. Running make will produce the docset in that directory and
1432# running make install will install the docset in
1433# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1434# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1435# genXcode/_index.html for more information.
1436# The default value is: NO.
1437# This tag requires that the tag GENERATE_HTML is set to YES.
765 1438
766GENERATE_DOCSET = NO 1439GENERATE_DOCSET = NO
767 1440
768# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 1441# This tag determines the name of the docset feed. A documentation feed provides
769# feed. A documentation feed provides an umbrella under which multiple 1442# an umbrella under which multiple documentation sets from a single provider
770# documentation sets from a single provider (such as a company or product suite) 1443# (such as a company or product suite) can be grouped.
771# can be grouped. 1444# The default value is: Doxygen generated docs.
1445# This tag requires that the tag GENERATE_DOCSET is set to YES.
772 1446
773DOCSET_FEEDNAME = "Doxygen generated docs" 1447DOCSET_FEEDNAME = "Doxygen generated docs"
774 1448
775# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 1449# This tag determines the URL of the docset feed. A documentation feed provides
776# should uniquely identify the documentation set bundle. This should be a 1450# an umbrella under which multiple documentation sets from a single provider
777# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 1451# (such as a company or product suite) can be grouped.
778# will append .docset to the name. 1452# This tag requires that the tag GENERATE_DOCSET is set to YES.
1453
1454DOCSET_FEEDURL =
1455
1456# This tag specifies a string that should uniquely identify the documentation
1457# set bundle. This should be a reverse domain-name style string, e.g.
1458# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1459# The default value is: org.doxygen.Project.
1460# This tag requires that the tag GENERATE_DOCSET is set to YES.
779 1461
780DOCSET_BUNDLE_ID = org.doxygen.Project 1462DOCSET_BUNDLE_ID = org.doxygen.Project
781 1463
782# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1464# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
783# documentation will contain sections that can be hidden and shown after the 1465# the documentation publisher. This should be a reverse domain-name style
784# page has loaded. For this to work a browser that supports 1466# string, e.g. com.mycompany.MyDocSet.documentation.
785# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 1467# The default value is: org.doxygen.Publisher.
786# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 1468# This tag requires that the tag GENERATE_DOCSET is set to YES.
1469
1470DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1471
1472# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1473# The default value is: Publisher.
1474# This tag requires that the tag GENERATE_DOCSET is set to YES.
1475
1476DOCSET_PUBLISHER_NAME = Publisher
1477
1478# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1479# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1480# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1481# on Windows. In the beginning of 2021 Microsoft took the original page, with
1482# a.o. the download links, offline the HTML help workshop was already many years
1483# in maintenance mode). You can download the HTML help workshop from the web
1484# archives at Installation executable (see:
1485# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
1486# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1487#
1488# The HTML Help Workshop contains a compiler that can convert all HTML output
1489# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1490# files are now used as the Windows 98 help format, and will replace the old
1491# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1492# HTML files also contain an index, a table of contents, and you can search for
1493# words in the documentation. The HTML workshop also contains a viewer for
1494# compressed HTML files.
1495# The default value is: NO.
1496# This tag requires that the tag GENERATE_HTML is set to YES.
787 1497
788HTML_DYNAMIC_SECTIONS = NO 1498GENERATE_HTMLHELP = NO
789 1499
790# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 1500# The CHM_FILE tag can be used to specify the file name of the resulting .chm
791# be used to specify the file name of the resulting .chm file. You 1501# file. You can add a path in front of the file if the result should not be
792# can add a path in front of the file if the result should not be
793# written to the html output directory. 1502# written to the html output directory.
1503# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
794 1504
795CHM_FILE = 1505CHM_FILE =
796 1506
797# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1507# The HHC_LOCATION tag can be used to specify the location (absolute path
798# be used to specify the location (absolute path including file name) of 1508# including file name) of the HTML help compiler (hhc.exe). If non-empty,
799# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1509# doxygen will try to run the HTML help compiler on the generated index.hhp.
800# the HTML help compiler on the generated index.hhp. 1510# The file has to be specified with full path.
1511# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
801 1512
802HHC_LOCATION = 1513HHC_LOCATION =
803 1514
804# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1515# The GENERATE_CHI flag controls if a separate .chi index file is generated
805# controls if a separate .chi index file is generated (YES) or that 1516# (YES) or that it should be included in the main .chm file (NO).
806# it should be included in the master .chm file (NO). 1517# The default value is: NO.
1518# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
807 1519
808GENERATE_CHI = NO 1520GENERATE_CHI = NO
809 1521
810# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 1522# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
811# is used to encode HtmlHelp index (hhk), content (hhc) and project file 1523# and project file content.
812# content. 1524# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
813 1525
814CHM_INDEX_ENCODING = 1526CHM_INDEX_ENCODING =
815 1527
816# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1528# The BINARY_TOC flag controls whether a binary table of contents is generated
817# controls whether a binary table of contents is generated (YES) or a 1529# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
818# normal table of contents (NO) in the .chm file. 1530# enables the Previous and Next buttons.
1531# The default value is: NO.
1532# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
819 1533
820BINARY_TOC = NO 1534BINARY_TOC = NO
821 1535
822# The TOC_EXPAND flag can be set to YES to add extra items for group members 1536# The TOC_EXPAND flag can be set to YES to add extra items for group members to
823# to the contents of the HTML help documentation and to the tree view. 1537# the table of contents of the HTML help documentation and to the tree view.
1538# The default value is: NO.
1539# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
824 1540
825TOC_EXPAND = NO 1541TOC_EXPAND = NO
826 1542
827# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 1543# The SITEMAP_URL tag is used to specify the full URL of the place where the
828# top of each HTML page. The value NO (the default) enables the index and 1544# generated documentation will be placed on the server by the user during the
829# the value YES disables it. 1545# deployment of the documentation. The generated sitemap is called sitemap.xml
1546# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL
1547# is specified no sitemap is generated. For information about the sitemap
1548# protocol see https://www.sitemaps.org
1549# This tag requires that the tag GENERATE_HTML is set to YES.
1550
1551SITEMAP_URL =
1552
1553# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1554# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1555# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1556# (.qch) of the generated HTML documentation.
1557# The default value is: NO.
1558# This tag requires that the tag GENERATE_HTML is set to YES.
1559
1560GENERATE_QHP = NO
1561
1562# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1563# the file name of the resulting .qch file. The path specified is relative to
1564# the HTML output folder.
1565# This tag requires that the tag GENERATE_QHP is set to YES.
1566
1567QCH_FILE =
1568
1569# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1570# Project output. For more information please see Qt Help Project / Namespace
1571# (see:
1572# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1573# The default value is: org.doxygen.Project.
1574# This tag requires that the tag GENERATE_QHP is set to YES.
1575
1576QHP_NAMESPACE = org.doxygen.Project
1577
1578# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1579# Help Project output. For more information please see Qt Help Project / Virtual
1580# Folders (see:
1581# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1582# The default value is: doc.
1583# This tag requires that the tag GENERATE_QHP is set to YES.
1584
1585QHP_VIRTUAL_FOLDER = doc
1586
1587# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1588# filter to add. For more information please see Qt Help Project / Custom
1589# Filters (see:
1590# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1591# This tag requires that the tag GENERATE_QHP is set to YES.
1592
1593QHP_CUST_FILTER_NAME =
1594
1595# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1596# custom filter to add. For more information please see Qt Help Project / Custom
1597# Filters (see:
1598# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1599# This tag requires that the tag GENERATE_QHP is set to YES.
1600
1601QHP_CUST_FILTER_ATTRS =
1602
1603# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1604# project's filter section matches. Qt Help Project / Filter Attributes (see:
1605# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1606# This tag requires that the tag GENERATE_QHP is set to YES.
1607
1608QHP_SECT_FILTER_ATTRS =
1609
1610# The QHG_LOCATION tag can be used to specify the location (absolute path
1611# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1612# run qhelpgenerator on the generated .qhp file.
1613# This tag requires that the tag GENERATE_QHP is set to YES.
1614
1615QHG_LOCATION =
1616
1617# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1618# generated, together with the HTML files, they form an Eclipse help plugin. To
1619# install this plugin and make it available under the help contents menu in
1620# Eclipse, the contents of the directory containing the HTML and XML files needs
1621# to be copied into the plugins directory of eclipse. The name of the directory
1622# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1623# After copying Eclipse needs to be restarted before the help appears.
1624# The default value is: NO.
1625# This tag requires that the tag GENERATE_HTML is set to YES.
1626
1627GENERATE_ECLIPSEHELP = NO
1628
1629# A unique identifier for the Eclipse help plugin. When installing the plugin
1630# the directory name containing the HTML and XML files should also have this
1631# name. Each documentation set should have its own identifier.
1632# The default value is: org.doxygen.Project.
1633# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1634
1635ECLIPSE_DOC_ID = org.doxygen.Project
1636
1637# If you want full control over the layout of the generated HTML pages it might
1638# be necessary to disable the index and replace it with your own. The
1639# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1640# of each HTML page. A value of NO enables the index and the value YES disables
1641# it. Since the tabs in the index contain the same information as the navigation
1642# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1643# The default value is: NO.
1644# This tag requires that the tag GENERATE_HTML is set to YES.
830 1645
831DISABLE_INDEX = NO 1646DISABLE_INDEX = NO
832 1647
833# This tag can be used to set the number of enum values (range [1..20]) 1648# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
834# that doxygen will group on one line in the generated HTML documentation. 1649# structure should be generated to display hierarchical information. If the tag
1650# value is set to YES, a side panel will be generated containing a tree-like
1651# index structure (just like the one that is generated for HTML Help). For this
1652# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1653# (i.e. any modern browser). Windows users are probably better off using the
1654# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1655# further fine tune the look of the index (see "Fine-tuning the output"). As an
1656# example, the default style sheet generated by doxygen has an example that
1657# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1658# Since the tree basically has the same information as the tab index, you could
1659# consider setting DISABLE_INDEX to YES when enabling this option.
1660# The default value is: NO.
1661# This tag requires that the tag GENERATE_HTML is set to YES.
1662
1663GENERATE_TREEVIEW = NONE
1664
1665# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
1666# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1667# area (value NO) or if it should extend to the full height of the window (value
1668# YES). Setting this to YES gives a layout similar to
1669# https://docs.readthedocs.io with more room for contents, but less room for the
1670# project logo, title, and description. If either GENERATE_TREEVIEW or
1671# DISABLE_INDEX is set to NO, this option has no effect.
1672# The default value is: NO.
1673# This tag requires that the tag GENERATE_HTML is set to YES.
1674
1675FULL_SIDEBAR = NO
1676
1677# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1678# doxygen will group on one line in the generated HTML documentation.
1679#
1680# Note that a value of 0 will completely suppress the enum values from appearing
1681# in the overview section.
1682# Minimum value: 0, maximum value: 20, default value: 4.
1683# This tag requires that the tag GENERATE_HTML is set to YES.
835 1684
836ENUM_VALUES_PER_LINE = 1 1685ENUM_VALUES_PER_LINE = 1
837 1686
838# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1687# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
839# structure should be generated to display hierarchical information. 1688# to set the initial width (in pixels) of the frame in which the tree is shown.
840# If the tag value is set to FRAME, a side panel will be generated 1689# Minimum value: 0, maximum value: 1500, default value: 250.
841# containing a tree-like index structure (just like the one that 1690# This tag requires that the tag GENERATE_HTML is set to YES.
842# is generated for HTML Help). For this to work a browser that supports
843# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
844# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
845# probably better off using the HTML help feature. Other possible values
846# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
847# and Class Hiererachy pages using a tree view instead of an ordered list;
848# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
849# disables this behavior completely. For backwards compatibility with previous
850# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
851# respectively.
852
853GENERATE_TREEVIEW = NO
854
855# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
856# used to set the initial width (in pixels) of the frame in which the tree
857# is shown.
858 1691
859TREEVIEW_WIDTH = 250 1692TREEVIEW_WIDTH = 250
860 1693
861# Use this tag to change the font size of Latex formulas included 1694# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
862# as images in the HTML documentation. The default is 10. Note that 1695# external symbols imported via tag files in a separate window.
863# when you change the font size after a successful doxygen run you need 1696# The default value is: NO.
864# to manually remove any form_*.png images from the HTML output directory 1697# This tag requires that the tag GENERATE_HTML is set to YES.
865# to force them to be regenerated. 1698
1699EXT_LINKS_IN_WINDOW = NO
1700
1701# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1702# addresses.
1703# The default value is: YES.
1704# This tag requires that the tag GENERATE_HTML is set to YES.
1705
1706OBFUSCATE_EMAILS = YES
1707
1708# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1709# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1710# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1711# the HTML output. These images will generally look nicer at scaled resolutions.
1712# Possible values are: png (the default) and svg (looks nicer but requires the
1713# pdf2svg or inkscape tool).
1714# The default value is: png.
1715# This tag requires that the tag GENERATE_HTML is set to YES.
1716
1717HTML_FORMULA_FORMAT = png
1718
1719# Use this tag to change the font size of LaTeX formulas included as images in
1720# the HTML documentation. When you change the font size after a successful
1721# doxygen run you need to manually remove any form_*.png images from the HTML
1722# output directory to force them to be regenerated.
1723# Minimum value: 8, maximum value: 50, default value: 10.
1724# This tag requires that the tag GENERATE_HTML is set to YES.
866 1725
867FORMULA_FONTSIZE = 10 1726FORMULA_FONTSIZE = 10
868 1727
1728# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1729# to create new LaTeX commands to be used in formulas as building blocks. See
1730# the section "Including formulas" for details.
1731
1732FORMULA_MACROFILE =
1733
1734# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1735# https://www.mathjax.org) which uses client side JavaScript for the rendering
1736# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1737# installed or if you want to formulas look prettier in the HTML output. When
1738# enabled you may also need to install MathJax separately and configure the path
1739# to it using the MATHJAX_RELPATH option.
1740# The default value is: NO.
1741# This tag requires that the tag GENERATE_HTML is set to YES.
1742
1743USE_MATHJAX = NO
1744
1745# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1746# Note that the different versions of MathJax have different requirements with
1747# regards to the different settings, so it is possible that also other MathJax
1748# settings have to be changed when switching between the different MathJax
1749# versions.
1750# Possible values are: MathJax_2 and MathJax_3.
1751# The default value is: MathJax_2.
1752# This tag requires that the tag USE_MATHJAX is set to YES.
1753
1754MATHJAX_VERSION = MathJax_2
1755
1756# When MathJax is enabled you can set the default output format to be used for
1757# the MathJax output. For more details about the output format see MathJax
1758# version 2 (see:
1759# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1760# (see:
1761# http://docs.mathjax.org/en/latest/web/components/output.html).
1762# Possible values are: HTML-CSS (which is slower, but has the best
1763# compatibility. This is the name for Mathjax version 2, for MathJax version 3
1764# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1765# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1766# is the name for Mathjax version 3, for MathJax version 2 this will be
1767# translated into HTML-CSS) and SVG.
1768# The default value is: HTML-CSS.
1769# This tag requires that the tag USE_MATHJAX is set to YES.
1770
1771MATHJAX_FORMAT = HTML-CSS
1772
1773# When MathJax is enabled you need to specify the location relative to the HTML
1774# output directory using the MATHJAX_RELPATH option. The destination directory
1775# should contain the MathJax.js script. For instance, if the mathjax directory
1776# is located at the same level as the HTML output directory, then
1777# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1778# Content Delivery Network so you can quickly see the result without installing
1779# MathJax. However, it is strongly recommended to install a local copy of
1780# MathJax from https://www.mathjax.org before deployment. The default value is:
1781# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1782# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1783# This tag requires that the tag USE_MATHJAX is set to YES.
1784
1785MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1786
1787# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1788# extension names that should be enabled during MathJax rendering. For example
1789# for MathJax version 2 (see
1790# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1791# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1792# For example for MathJax version 3 (see
1793# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
1794# MATHJAX_EXTENSIONS = ams
1795# This tag requires that the tag USE_MATHJAX is set to YES.
1796
1797MATHJAX_EXTENSIONS =
1798
1799# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1800# of code that will be used on startup of the MathJax code. See the MathJax site
1801# (see:
1802# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1803# example see the documentation.
1804# This tag requires that the tag USE_MATHJAX is set to YES.
1805
1806MATHJAX_CODEFILE =
1807
1808# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1809# the HTML output. The underlying search engine uses javascript and DHTML and
1810# should work on any modern browser. Note that when using HTML help
1811# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1812# there is already a search function so this one should typically be disabled.
1813# For large projects the javascript based search engine can be slow, then
1814# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1815# search using the keyboard; to jump to the search box use <access key> + S
1816# (what the <access key> is depends on the OS and browser, but it is typically
1817# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1818# key> to jump into the search results window, the results can be navigated
1819# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1820# the search. The filter options can be selected when the cursor is inside the
1821# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1822# to select a filter and <Enter> or <escape> to activate or cancel the filter
1823# option.
1824# The default value is: YES.
1825# This tag requires that the tag GENERATE_HTML is set to YES.
1826
1827SEARCHENGINE = NO
1828
1829# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1830# implemented using a web server instead of a web client using JavaScript. There
1831# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1832# setting. When disabled, doxygen will generate a PHP script for searching and
1833# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1834# and searching needs to be provided by external tools. See the section
1835# "External Indexing and Searching" for details.
1836# The default value is: NO.
1837# This tag requires that the tag SEARCHENGINE is set to YES.
1838
1839SERVER_BASED_SEARCH = NO
1840
1841# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1842# script for searching. Instead the search results are written to an XML file
1843# which needs to be processed by an external indexer. Doxygen will invoke an
1844# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1845# search results.
1846#
1847# Doxygen ships with an example indexer (doxyindexer) and search engine
1848# (doxysearch.cgi) which are based on the open source search engine library
1849# Xapian (see:
1850# https://xapian.org/).
1851#
1852# See the section "External Indexing and Searching" for details.
1853# The default value is: NO.
1854# This tag requires that the tag SEARCHENGINE is set to YES.
1855
1856EXTERNAL_SEARCH = NO
1857
1858# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1859# which will return the search results when EXTERNAL_SEARCH is enabled.
1860#
1861# Doxygen ships with an example indexer (doxyindexer) and search engine
1862# (doxysearch.cgi) which are based on the open source search engine library
1863# Xapian (see:
1864# https://xapian.org/). See the section "External Indexing and Searching" for
1865# details.
1866# This tag requires that the tag SEARCHENGINE is set to YES.
1867
1868SEARCHENGINE_URL =
1869
1870# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1871# search data is written to a file for indexing by an external tool. With the
1872# SEARCHDATA_FILE tag the name of this file can be specified.
1873# The default file is: searchdata.xml.
1874# This tag requires that the tag SEARCHENGINE is set to YES.
1875
1876SEARCHDATA_FILE = searchdata.xml
1877
1878# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1879# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1880# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1881# projects and redirect the results back to the right project.
1882# This tag requires that the tag SEARCHENGINE is set to YES.
1883
1884EXTERNAL_SEARCH_ID =
1885
1886# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1887# projects other than the one defined by this configuration file, but that are
1888# all added to the same external search index. Each project needs to have a
1889# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1890# to a relative location where the documentation can be found. The format is:
1891# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1892# This tag requires that the tag SEARCHENGINE is set to YES.
1893
1894EXTRA_SEARCH_MAPPINGS =
1895
869#--------------------------------------------------------------------------- 1896#---------------------------------------------------------------------------
870# configuration options related to the LaTeX output 1897# Configuration options related to the LaTeX output
871#--------------------------------------------------------------------------- 1898#---------------------------------------------------------------------------
872 1899
873# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1900# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
874# generate Latex output. 1901# The default value is: YES.
875 1902
876GENERATE_LATEX = NO 1903GENERATE_LATEX = NO
877 1904
878# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1905# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
879# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1906# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
880# put in front of it. If left blank `latex' will be used as the default path. 1907# it.
1908# The default directory is: latex.
1909# This tag requires that the tag GENERATE_LATEX is set to YES.
881 1910
882LATEX_OUTPUT = latex 1911LATEX_OUTPUT = latex
883 1912
884# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1913# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
885# invoked. If left blank `latex' will be used as the default command name. 1914# invoked.
1915#
1916# Note that when not enabling USE_PDFLATEX the default is latex when enabling
1917# USE_PDFLATEX the default is pdflatex and when in the later case latex is
1918# chosen this is overwritten by pdflatex. For specific output languages the
1919# default can have been set differently, this depends on the implementation of
1920# the output language.
1921# This tag requires that the tag GENERATE_LATEX is set to YES.
886 1922
887LATEX_CMD_NAME = latex 1923LATEX_CMD_NAME = latex
888 1924
889# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1925# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
890# generate index for LaTeX. If left blank `makeindex' will be used as the 1926# index for LaTeX.
891# default command name. 1927# Note: This tag is used in the Makefile / make.bat.
1928# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1929# (.tex).
1930# The default file is: makeindex.
1931# This tag requires that the tag GENERATE_LATEX is set to YES.
892 1932
893MAKEINDEX_CMD_NAME = makeindex 1933MAKEINDEX_CMD_NAME = makeindex
894 1934
895# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1935# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
896# LaTeX documents. This may be useful for small projects and may help to 1936# generate index for LaTeX. In case there is no backslash (\) as first character
897# save some trees in general. 1937# it will be automatically added in the LaTeX code.
898 1938# Note: This tag is used in the generated output file (.tex).
899COMPACT_LATEX = NO 1939# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
900 1940# The default value is: makeindex.
901# The PAPER_TYPE tag can be used to set the paper type that is used 1941# This tag requires that the tag GENERATE_LATEX is set to YES.
902# by the printer. Possible values are: a4, letter, legal and executive.
903# If left blank a4 will be used.
904 1942
905PAPER_TYPE = a4 1943LATEX_MAKEINDEX_CMD = makeindex
906 1944
907# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1945# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
908# packages that should be included in the LaTeX output. 1946# documents. This may be useful for small projects and may help to save some
1947# trees in general.
1948# The default value is: NO.
1949# This tag requires that the tag GENERATE_LATEX is set to YES.
909 1950
910EXTRA_PACKAGES = 1951COMPACT_LATEX = NO
911 1952
912# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1953# The PAPER_TYPE tag can be used to set the paper type that is used by the
913# the generated latex document. The header should contain everything until 1954# printer.
914# the first chapter. If it is left blank doxygen will generate a 1955# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
915# standard header. Notice: only use this tag if you know what you are doing! 1956# 14 inches) and executive (7.25 x 10.5 inches).
1957# The default value is: a4.
1958# This tag requires that the tag GENERATE_LATEX is set to YES.
916 1959
917LATEX_HEADER = 1960PAPER_TYPE = a4
918 1961
919# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1962# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
920# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1963# that should be included in the LaTeX output. The package can be specified just
921# contain links (just like the HTML output) instead of page references 1964# by its name or with the correct syntax as to be used with the LaTeX
922# This makes the output suitable for online browsing using a pdf viewer. 1965# \usepackage command. To get the times font for instance you can specify :
1966# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1967# To use the option intlimits with the amsmath package you can specify:
1968# EXTRA_PACKAGES=[intlimits]{amsmath}
1969# If left blank no extra packages will be included.
1970# This tag requires that the tag GENERATE_LATEX is set to YES.
1971
1972EXTRA_PACKAGES =
1973
1974# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
1975# the generated LaTeX document. The header should contain everything until the
1976# first chapter. If it is left blank doxygen will generate a standard header. It
1977# is highly recommended to start with a default header using
1978# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
1979# and then modify the file new_header.tex. See also section "Doxygen usage" for
1980# information on how to generate the default header that doxygen normally uses.
1981#
1982# Note: Only use a user-defined header if you know what you are doing!
1983# Note: The header is subject to change so you typically have to regenerate the
1984# default header when upgrading to a newer version of doxygen. The following
1985# commands have a special meaning inside the header (and footer): For a
1986# description of the possible markers and block names see the documentation.
1987# This tag requires that the tag GENERATE_LATEX is set to YES.
1988
1989LATEX_HEADER =
1990
1991# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
1992# the generated LaTeX document. The footer should contain everything after the
1993# last chapter. If it is left blank doxygen will generate a standard footer. See
1994# LATEX_HEADER for more information on how to generate a default footer and what
1995# special commands can be used inside the footer. See also section "Doxygen
1996# usage" for information on how to generate the default footer that doxygen
1997# normally uses. Note: Only use a user-defined footer if you know what you are
1998# doing!
1999# This tag requires that the tag GENERATE_LATEX is set to YES.
2000
2001LATEX_FOOTER =
2002
2003# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2004# LaTeX style sheets that are included after the standard style sheets created
2005# by doxygen. Using this option one can overrule certain style aspects. Doxygen
2006# will copy the style sheet files to the output directory.
2007# Note: The order of the extra style sheet files is of importance (e.g. the last
2008# style sheet in the list overrules the setting of the previous ones in the
2009# list).
2010# This tag requires that the tag GENERATE_LATEX is set to YES.
2011
2012LATEX_EXTRA_STYLESHEET =
2013
2014# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2015# other source files which should be copied to the LATEX_OUTPUT output
2016# directory. Note that the files will be copied as-is; there are no commands or
2017# markers available.
2018# This tag requires that the tag GENERATE_LATEX is set to YES.
2019
2020LATEX_EXTRA_FILES =
2021
2022# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2023# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2024# contain links (just like the HTML output) instead of page references. This
2025# makes the output suitable for online browsing using a PDF viewer.
2026# The default value is: YES.
2027# This tag requires that the tag GENERATE_LATEX is set to YES.
923 2028
924PDF_HYPERLINKS = NO 2029PDF_HYPERLINKS = NO
925 2030
926# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 2031# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
927# plain latex in the generated Makefile. Set this option to YES to get a 2032# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
928# higher quality PDF documentation. 2033# files. Set this option to YES, to get a higher quality PDF documentation.
2034#
2035# See also section LATEX_CMD_NAME for selecting the engine.
2036# The default value is: YES.
2037# This tag requires that the tag GENERATE_LATEX is set to YES.
929 2038
930USE_PDFLATEX = NO 2039USE_PDFLATEX = NO
931 2040
932# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 2041# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error.
933# command to the generated LaTeX files. This will instruct LaTeX to keep 2042# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
934# running if errors occur, instead of asking the user for help. 2043# mode nothing is printed on the terminal, errors are scrolled as if <return> is
935# This option is also used when generating formulas in HTML. 2044# hit at every error; missing files that TeX tries to input or request from
2045# keyboard input (\read on a not open input stream) cause the job to abort,
2046# NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
2047# but there is no possibility of user interaction just like in batch mode,
2048# SCROLL In scroll mode, TeX will stop only for missing files to input or if
2049# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
2050# each error, asking for user intervention.
2051# The default value is: NO.
2052# This tag requires that the tag GENERATE_LATEX is set to YES.
936 2053
937LATEX_BATCHMODE = NO 2054LATEX_BATCHMODE = NO
938 2055
939# If LATEX_HIDE_INDICES is set to YES then doxygen will not 2056# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
940# include the index chapters (such as File Index, Compound Index, etc.) 2057# index chapters (such as File Index, Compound Index, etc.) in the output.
941# in the output. 2058# The default value is: NO.
2059# This tag requires that the tag GENERATE_LATEX is set to YES.
942 2060
943LATEX_HIDE_INDICES = NO 2061LATEX_HIDE_INDICES = NO
944 2062
2063# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2064# bibliography, e.g. plainnat, or ieeetr. See
2065# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2066# The default value is: plain.
2067# This tag requires that the tag GENERATE_LATEX is set to YES.
2068
2069LATEX_BIB_STYLE = plain
2070
2071# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2072# path from which the emoji images will be read. If a relative path is entered,
2073# it will be relative to the LATEX_OUTPUT directory. If left blank the
2074# LATEX_OUTPUT directory will be used.
2075# This tag requires that the tag GENERATE_LATEX is set to YES.
2076
2077LATEX_EMOJI_DIRECTORY =
2078
945#--------------------------------------------------------------------------- 2079#---------------------------------------------------------------------------
946# configuration options related to the RTF output 2080# Configuration options related to the RTF output
947#--------------------------------------------------------------------------- 2081#---------------------------------------------------------------------------
948 2082
949# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 2083# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
950# The RTF output is optimized for Word 97 and may not look very pretty with 2084# RTF output is optimized for Word 97 and may not look too pretty with other RTF
951# other RTF readers or editors. 2085# readers/editors.
2086# The default value is: NO.
952 2087
953GENERATE_RTF = NO 2088GENERATE_RTF = NO
954 2089
955# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 2090# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
956# If a relative path is entered the value of OUTPUT_DIRECTORY will be 2091# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
957# put in front of it. If left blank `rtf' will be used as the default path. 2092# it.
2093# The default directory is: rtf.
2094# This tag requires that the tag GENERATE_RTF is set to YES.
958 2095
959RTF_OUTPUT = rtf 2096RTF_OUTPUT = rtf
960 2097
961# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 2098# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
962# RTF documents. This may be useful for small projects and may help to 2099# documents. This may be useful for small projects and may help to save some
963# save some trees in general. 2100# trees in general.
2101# The default value is: NO.
2102# This tag requires that the tag GENERATE_RTF is set to YES.
964 2103
965COMPACT_RTF = NO 2104COMPACT_RTF = NO
966 2105
967# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 2106# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
968# will contain hyperlink fields. The RTF file will 2107# contain hyperlink fields. The RTF file will contain links (just like the HTML
969# contain links (just like the HTML output) instead of page references. 2108# output) instead of page references. This makes the output suitable for online
970# This makes the output suitable for online browsing using WORD or other 2109# browsing using Word or some other Word compatible readers that support those
971# programs which support those fields. 2110# fields.
972# Note: wordpad (write) and others do not support links. 2111#
2112# Note: WordPad (write) and others do not support links.
2113# The default value is: NO.
2114# This tag requires that the tag GENERATE_RTF is set to YES.
973 2115
974RTF_HYPERLINKS = NO 2116RTF_HYPERLINKS = NO
975 2117
976# Load stylesheet definitions from file. Syntax is similar to doxygen's 2118# Load stylesheet definitions from file. Syntax is similar to doxygen's
977# config file, i.e. a series of assignments. You only have to provide 2119# configuration file, i.e. a series of assignments. You only have to provide
978# replacements, missing definitions are set to their default value. 2120# replacements, missing definitions are set to their default value.
2121#
2122# See also section "Doxygen usage" for information on how to generate the
2123# default style sheet that doxygen normally uses.
2124# This tag requires that the tag GENERATE_RTF is set to YES.
2125
2126RTF_STYLESHEET_FILE =
2127
2128# Set optional variables used in the generation of an RTF document. Syntax is
2129# similar to doxygen's configuration file. A template extensions file can be
2130# generated using doxygen -e rtf extensionFile.
2131# This tag requires that the tag GENERATE_RTF is set to YES.
979 2132
980RTF_STYLESHEET_FILE = 2133RTF_EXTENSIONS_FILE =
981 2134
982# Set optional variables used in the generation of an rtf document. 2135# The RTF_EXTRA_FILES tag can be used to specify one or more extra images or
983# Syntax is similar to doxygen's config file. 2136# other source files which should be copied to the RTF_OUTPUT output directory.
2137# Note that the files will be copied as-is; there are no commands or markers
2138# available.
2139# This tag requires that the tag GENERATE_RTF is set to YES.
984 2140
985RTF_EXTENSIONS_FILE = 2141RTF_EXTRA_FILES =
986 2142
987#--------------------------------------------------------------------------- 2143#---------------------------------------------------------------------------
988# configuration options related to the man page output 2144# Configuration options related to the man page output
989#--------------------------------------------------------------------------- 2145#---------------------------------------------------------------------------
990 2146
991# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 2147# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
992# generate man pages 2148# classes and files.
2149# The default value is: NO.
993 2150
994GENERATE_MAN = NO 2151GENERATE_MAN = NO
995 2152
996# The MAN_OUTPUT tag is used to specify where the man pages will be put. 2153# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
997# If a relative path is entered the value of OUTPUT_DIRECTORY will be 2154# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
998# put in front of it. If left blank `man' will be used as the default path. 2155# it. A directory man3 will be created inside the directory specified by
2156# MAN_OUTPUT.
2157# The default directory is: man.
2158# This tag requires that the tag GENERATE_MAN is set to YES.
999 2159
1000MAN_OUTPUT = man 2160MAN_OUTPUT = man
1001 2161
1002# The MAN_EXTENSION tag determines the extension that is added to 2162# The MAN_EXTENSION tag determines the extension that is added to the generated
1003# the generated man pages (default is the subroutine's section .3) 2163# man pages. In case the manual section does not start with a number, the number
2164# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2165# optional.
2166# The default value is: .3.
2167# This tag requires that the tag GENERATE_MAN is set to YES.
1004 2168
1005MAN_EXTENSION = .3 2169MAN_EXTENSION = .3
1006 2170
1007# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 2171# The MAN_SUBDIR tag determines the name of the directory created within
1008# then it will generate one additional man file for each entity 2172# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1009# documented in the real man page(s). These additional files 2173# MAN_EXTENSION with the initial . removed.
1010# only source the real man page, but without them the man command 2174# This tag requires that the tag GENERATE_MAN is set to YES.
1011# would be unable to find the correct page. The default is NO. 2175
2176MAN_SUBDIR =
2177
2178# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2179# will generate one additional man file for each entity documented in the real
2180# man page(s). These additional files only source the real man page, but without
2181# them the man command would be unable to find the correct page.
2182# The default value is: NO.
2183# This tag requires that the tag GENERATE_MAN is set to YES.
1012 2184
1013MAN_LINKS = NO 2185MAN_LINKS = NO
1014 2186
1015#--------------------------------------------------------------------------- 2187#---------------------------------------------------------------------------
1016# configuration options related to the XML output 2188# Configuration options related to the XML output
1017#--------------------------------------------------------------------------- 2189#---------------------------------------------------------------------------
1018 2190
1019# If the GENERATE_XML tag is set to YES Doxygen will 2191# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1020# generate an XML file that captures the structure of 2192# captures the structure of the code including all documentation.
1021# the code including all documentation. 2193# The default value is: NO.
1022 2194
1023GENERATE_XML = NO 2195GENERATE_XML = NO
1024 2196
1025# The XML_OUTPUT tag is used to specify where the XML pages will be put. 2197# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1026# If a relative path is entered the value of OUTPUT_DIRECTORY will be 2198# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1027# put in front of it. If left blank `xml' will be used as the default path. 2199# it.
2200# The default directory is: xml.
2201# This tag requires that the tag GENERATE_XML is set to YES.
1028 2202
1029XML_OUTPUT = xml 2203XML_OUTPUT = xml
1030 2204
1031# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 2205# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1032# dump the program listings (including syntax highlighting 2206# listings (including syntax highlighting and cross-referencing information) to
1033# and cross-referencing information) to the XML output. Note that 2207# the XML output. Note that enabling this will significantly increase the size
1034# enabling this will significantly increase the size of the XML output. 2208# of the XML output.
2209# The default value is: YES.
2210# This tag requires that the tag GENERATE_XML is set to YES.
1035 2211
1036XML_PROGRAMLISTING = YES 2212XML_PROGRAMLISTING = YES
1037 2213
2214# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2215# namespace members in file scope as well, matching the HTML output.
2216# The default value is: NO.
2217# This tag requires that the tag GENERATE_XML is set to YES.
2218
2219XML_NS_MEMB_FILE_SCOPE = NO
2220
1038#--------------------------------------------------------------------------- 2221#---------------------------------------------------------------------------
1039# configuration options for the AutoGen Definitions output 2222# Configuration options related to the DOCBOOK output
1040#--------------------------------------------------------------------------- 2223#---------------------------------------------------------------------------
1041 2224
1042# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 2225# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1043# generate an AutoGen Definitions (see autogen.sf.net) file 2226# that can be used to generate PDF.
1044# that captures the structure of the code including all 2227# The default value is: NO.
1045# documentation. Note that this feature is still experimental
1046# and incomplete at the moment.
1047 2228
1048GENERATE_AUTOGEN_DEF = NO 2229GENERATE_DOCBOOK = NO
2230
2231# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2232# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2233# front of it.
2234# The default directory is: docbook.
2235# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2236
2237DOCBOOK_OUTPUT = docbook
1049 2238
1050#--------------------------------------------------------------------------- 2239#---------------------------------------------------------------------------
1051# configuration options related to the Perl module output 2240# Configuration options for the AutoGen Definitions output
1052#--------------------------------------------------------------------------- 2241#---------------------------------------------------------------------------
1053 2242
1054# If the GENERATE_PERLMOD tag is set to YES Doxygen will 2243# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1055# generate a Perl module file that captures the structure of 2244# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures
1056# the code including all documentation. Note that this 2245# the structure of the code including all documentation. Note that this feature
1057# feature is still experimental and incomplete at the 2246# is still experimental and incomplete at the moment.
1058# moment. 2247# The default value is: NO.
1059 2248
1060GENERATE_PERLMOD = NO 2249GENERATE_AUTOGEN_DEF = NO
1061 2250
1062# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 2251#---------------------------------------------------------------------------
1063# the necessary Makefile rules, Perl scripts and LaTeX code to be able 2252# Configuration options related to Sqlite3 output
1064# to generate PDF and DVI output from the Perl module output. 2253#---------------------------------------------------------------------------
1065 2254
1066PERLMOD_LATEX = NO 2255# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3
2256# database with symbols found by doxygen stored in tables.
2257# The default value is: NO.
1067 2258
1068# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 2259GENERATE_SQLITE3 = NO
1069# nicely formatted so it can be parsed by a human reader. This is useful
1070# if you want to understand what is going on. On the other hand, if this
1071# tag is set to NO the size of the Perl module output will be much smaller
1072# and Perl will parse it just the same.
1073 2260
1074PERLMOD_PRETTY = YES 2261# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
2262# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
2263# in front of it.
2264# The default directory is: sqlite3.
2265# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2266
2267SQLITE3_OUTPUT = sqlite3
1075 2268
1076# The names of the make variables in the generated doxyrules.make file 2269# The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db
1077# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 2270# database file will be recreated with each doxygen run. If set to NO, doxygen
1078# This is useful so different doxyrules.make files included by the same 2271# will warn if a database file is already found and not modify it.
1079# Makefile don't overwrite each other's variables. 2272# The default value is: YES.
2273# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
1080 2274
1081PERLMOD_MAKEVAR_PREFIX = 2275SQLITE3_RECREATE_DB = YES
1082 2276
1083#--------------------------------------------------------------------------- 2277#---------------------------------------------------------------------------
1084# Configuration options related to the preprocessor 2278# Configuration options related to the Perl module output
1085#--------------------------------------------------------------------------- 2279#---------------------------------------------------------------------------
1086 2280
1087# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 2281# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1088# evaluate all C-preprocessor directives found in the sources and include 2282# file that captures the structure of the code including all documentation.
1089# files. 2283#
2284# Note that this feature is still experimental and incomplete at the moment.
2285# The default value is: NO.
1090 2286
1091ENABLE_PREPROCESSING = YES 2287GENERATE_PERLMOD = NO
1092 2288
1093# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 2289# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1094# names in the source code. If set to NO (the default) only conditional 2290# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1095# compilation will be performed. Macro expansion can be done in a controlled 2291# output from the Perl module output.
1096# way by setting EXPAND_ONLY_PREDEF to YES. 2292# The default value is: NO.
2293# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1097 2294
1098MACRO_EXPANSION = YES 2295PERLMOD_LATEX = NO
1099 2296
1100# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 2297# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1101# then the macro expansion is limited to the macros specified with the 2298# formatted so it can be parsed by a human reader. This is useful if you want to
1102# PREDEFINED and EXPAND_AS_DEFINED tags. 2299# understand what is going on. On the other hand, if this tag is set to NO, the
2300# size of the Perl module output will be much smaller and Perl will parse it
2301# just the same.
2302# The default value is: YES.
2303# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1103 2304
1104EXPAND_ONLY_PREDEF = YES 2305PERLMOD_PRETTY = YES
1105 2306
1106# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 2307# The names of the make variables in the generated doxyrules.make file are
1107# in the INCLUDE_PATH (see below) will be search if a #include is found. 2308# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2309# so different doxyrules.make files included by the same Makefile don't
2310# overwrite each other's variables.
2311# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1108 2312
1109SEARCH_INCLUDES = NO 2313PERLMOD_MAKEVAR_PREFIX =
1110 2314
1111# The INCLUDE_PATH tag can be used to specify one or more directories that 2315#---------------------------------------------------------------------------
1112# contain include files that are not input files but should be processed by 2316# Configuration options related to the preprocessor
1113# the preprocessor. 2317#---------------------------------------------------------------------------
1114 2318
1115INCLUDE_PATH = 2319# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2320# C-preprocessor directives found in the sources and include files.
2321# The default value is: YES.
1116 2322
1117# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 2323ENABLE_PREPROCESSING = YES
1118# patterns (like *.h and *.hpp) to filter out the header-files in the
1119# directories. If left blank, the patterns specified with FILE_PATTERNS will
1120# be used.
1121 2324
1122INCLUDE_FILE_PATTERNS = 2325# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2326# in the source code. If set to NO, only conditional compilation will be
2327# performed. Macro expansion can be done in a controlled way by setting
2328# EXPAND_ONLY_PREDEF to YES.
2329# The default value is: NO.
2330# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1123 2331
1124# The PREDEFINED tag can be used to specify one or more macro names that 2332MACRO_EXPANSION = YES
1125# are defined before the preprocessor is started (similar to the -D option of
1126# gcc). The argument of the tag is a list of macros of the form: name
1127# or name=definition (no spaces). If the definition and the = are
1128# omitted =1 is assumed. To prevent a macro definition from being
1129# undefined via #undef or recursively expanded use the := operator
1130# instead of the = operator.
1131 2333
1132PREDEFINED = 2334# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2335# the macro expansion is limited to the macros specified with the PREDEFINED and
2336# EXPAND_AS_DEFINED tags.
2337# The default value is: NO.
2338# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1133 2339
1134# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 2340EXPAND_ONLY_PREDEF = YES
1135# this tag can be used to specify a list of macro names that should be expanded.
1136# The macro definition that is found in the sources will be used.
1137# Use the PREDEFINED tag if you want to use a different macro definition.
1138 2341
1139EXPAND_AS_DEFINED = PLIST_API 2342# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2343# INCLUDE_PATH will be searched if a #include is found.
2344# The default value is: YES.
2345# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1140 2346
1141# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 2347SEARCH_INCLUDES = NO
1142# doxygen's preprocessor will remove all function-like macros that are alone 2348
1143# on a line, have an all uppercase name, and do not end with a semicolon. Such 2349# The INCLUDE_PATH tag can be used to specify one or more directories that
1144# function macros are typically used for boiler-plate code, and will confuse 2350# contain include files that are not input files but should be processed by the
1145# the parser if not removed. 2351# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
2352# RECURSIVE has no effect here.
2353# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2354
2355INCLUDE_PATH =
2356
2357# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2358# patterns (like *.h and *.hpp) to filter out the header-files in the
2359# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2360# used.
2361# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2362
2363INCLUDE_FILE_PATTERNS =
2364
2365# The PREDEFINED tag can be used to specify one or more macro names that are
2366# defined before the preprocessor is started (similar to the -D option of e.g.
2367# gcc). The argument of the tag is a list of macros of the form: name or
2368# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2369# is assumed. To prevent a macro definition from being undefined via #undef or
2370# recursively expanded use the := operator instead of the = operator.
2371# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2372
2373PREDEFINED =
2374
2375# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2376# tag can be used to specify a list of macro names that should be expanded. The
2377# macro definition that is found in the sources will be used. Use the PREDEFINED
2378# tag if you want to use a different macro definition that overrules the
2379# definition found in the source code.
2380# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2381
2382EXPAND_AS_DEFINED = LIBIMOBILEDEVICE_API
2383
2384# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2385# remove all references to function-like macros that are alone on a line, have
2386# an all uppercase name, and do not end with a semicolon. Such function macros
2387# are typically used for boiler-plate code, and will confuse the parser if not
2388# removed.
2389# The default value is: YES.
2390# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1146 2391
1147SKIP_FUNCTION_MACROS = YES 2392SKIP_FUNCTION_MACROS = YES
1148 2393
1149#--------------------------------------------------------------------------- 2394#---------------------------------------------------------------------------
1150# Configuration::additions related to external references 2395# Configuration options related to external references
1151#--------------------------------------------------------------------------- 2396#---------------------------------------------------------------------------
1152 2397
1153# The TAGFILES option can be used to specify one or more tagfiles. 2398# The TAGFILES tag can be used to specify one or more tag files. For each tag
1154# Optionally an initial location of the external documentation 2399# file the location of the external documentation should be added. The format of
1155# can be added for each tagfile. The format of a tag file without 2400# a tag file without this location is as follows:
1156# this location is as follows: 2401# TAGFILES = file1 file2 ...
1157# TAGFILES = file1 file2 ... 2402# Adding location for the tag files is done as follows:
1158# Adding location for the tag files is done as follows: 2403# TAGFILES = file1=loc1 "file2 = loc2" ...
1159# TAGFILES = file1=loc1 "file2 = loc2" ... 2404# where loc1 and loc2 can be relative or absolute paths or URLs. See the
1160# where "loc1" and "loc2" can be relative or absolute paths or 2405# section "Linking to external documentation" for more information about the use
1161# URLs. If a location is present for each tag, the installdox tool 2406# of tag files.
1162# does not have to be run to correct the links. 2407# Note: Each tag file must have a unique name (where the name does NOT include
1163# Note that each tag file must have a unique name 2408# the path). If a tag file is not located in the directory in which doxygen is
1164# (where the name does NOT include the path) 2409# run, you must also specify the path to the tagfile here.
1165# If a tag file is not located in the directory in which doxygen
1166# is run, you must also specify the path to the tagfile here.
1167 2410
1168TAGFILES = 2411TAGFILES =
1169 2412
1170# When a file name is specified after GENERATE_TAGFILE, doxygen will create 2413# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
1171# a tag file that is based on the input files it reads. 2414# tag file that is based on the input files it reads. See section "Linking to
2415# external documentation" for more information about the usage of tag files.
1172 2416
1173GENERATE_TAGFILE = 2417GENERATE_TAGFILE =
1174 2418
1175# If the ALLEXTERNALS tag is set to YES all external classes will be listed 2419# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
1176# in the class index. If set to NO only the inherited external classes 2420# will be listed in the class and namespace index. If set to NO, only the
1177# will be listed. 2421# inherited external classes will be listed.
2422# The default value is: NO.
1178 2423
1179ALLEXTERNALS = NO 2424ALLEXTERNALS = NO
1180 2425
1181# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 2426# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
1182# in the modules index. If set to NO, only the current project's groups will 2427# in the topic index. If set to NO, only the current project's groups will be
1183# be listed. 2428# listed.
2429# The default value is: YES.
1184 2430
1185EXTERNAL_GROUPS = YES 2431EXTERNAL_GROUPS = YES
1186 2432
2433# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2434# the related pages index. If set to NO, only the current project's pages will
2435# be listed.
2436# The default value is: YES.
2437
2438EXTERNAL_PAGES = YES
2439
1187#--------------------------------------------------------------------------- 2440#---------------------------------------------------------------------------
1188# Configuration options related to the dot tool 2441# Configuration options related to diagram generator tools
1189#--------------------------------------------------------------------------- 2442#---------------------------------------------------------------------------
1190 2443
1191# If set to YES, the inheritance and collaboration graphs will hide 2444# If set to YES the inheritance and collaboration graphs will hide inheritance
1192# inheritance and usage relations if the target is undocumented 2445# and usage relations if the target is undocumented or is not a class.
1193# or is not a class. 2446# The default value is: YES.
1194 2447
1195HIDE_UNDOC_RELATIONS = YES 2448HIDE_UNDOC_RELATIONS = YES
1196 2449
1197# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2450# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1198# available from the path. This tool is part of Graphviz, a graph visualization 2451# available from the path. This tool is part of Graphviz (see:
1199# toolkit from AT&T and Lucent Bell Labs. The other options in this section 2452# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
1200# have no effect if this option is set to NO (the default) 2453# Bell Labs. The other options in this section have no effect if this option is
2454# set to NO
2455# The default value is: NO.
1201 2456
1202HAVE_DOT = NO 2457HAVE_DOT = NO
1203 2458
1204# You can set the path where dot can find font specified with fontname in DOT_COMMON_ATTR and others dot attributes. 2459# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2460# to run in parallel. When set to 0 doxygen will base this on the number of
2461# processors available in the system. You can set it explicitly to a value
2462# larger than 0 to get control over the balance between CPU load and processing
2463# speed.
2464# Minimum value: 0, maximum value: 32, default value: 0.
1205# This tag requires that the tag HAVE_DOT is set to YES. 2465# This tag requires that the tag HAVE_DOT is set to YES.
1206 2466
1207DOT_FONTPATH = 2467DOT_NUM_THREADS = 0
2468
2469# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2470# subgraphs. When you want a differently looking font in the dot files that
2471# doxygen generates you can specify fontname, fontcolor and fontsize attributes.
2472# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
2473# Edge and Graph Attributes specification</a> You need to make sure dot is able
2474# to find the font, which can be done by putting it in a standard location or by
2475# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2476# directory containing the font. Default graphviz fontsize is 14.
2477# The default value is: fontname=Helvetica,fontsize=10.
2478# This tag requires that the tag HAVE_DOT is set to YES.
2479
2480DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
2481
2482# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2483# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
2484# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
2485# arrows shapes.</a>
2486# The default value is: labelfontname=Helvetica,labelfontsize=10.
2487# This tag requires that the tag HAVE_DOT is set to YES.
2488
2489DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
2490
2491# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2492# around nodes set 'shape=plain' or 'shape=plaintext' <a
2493# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
2494# The default value is: shape=box,height=0.2,width=0.4.
2495# This tag requires that the tag HAVE_DOT is set to YES.
1208 2496
1209# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 2497DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
1210# will generate a graph for each documented class showing the direct and 2498
1211# indirect inheritance relations. Setting this tag to YES will force the 2499# You can set the path where dot can find font specified with fontname in
1212# the CLASS_DIAGRAMS tag to NO. 2500# DOT_COMMON_ATTR and others dot attributes.
2501# This tag requires that the tag HAVE_DOT is set to YES.
2502
2503DOT_FONTPATH =
2504
2505# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
2506# generate a graph for each documented class showing the direct and indirect
2507# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
2508# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2509# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
2510# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2511# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
2512# relations will be shown as texts / links. Explicit enabling an inheritance
2513# graph or choosing a different representation for an inheritance graph of a
2514# specific class, can be accomplished by means of the command \inheritancegraph.
2515# Disabling an inheritance graph can be accomplished by means of the command
2516# \hideinheritancegraph.
2517# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
2518# The default value is: YES.
1213 2519
1214CLASS_GRAPH = YES 2520CLASS_GRAPH = YES
1215 2521
1216# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 2522# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
1217# will generate a graph for each documented class showing the direct and 2523# graph for each documented class showing the direct and indirect implementation
1218# indirect implementation dependencies (inheritance, containment, and 2524# dependencies (inheritance, containment, and class references variables) of the
1219# class references variables) of the class with other documented classes. 2525# class with other documented classes. Explicit enabling a collaboration graph,
2526# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
2527# command \collaborationgraph. Disabling a collaboration graph can be
2528# accomplished by means of the command \hidecollaborationgraph.
2529# The default value is: YES.
2530# This tag requires that the tag HAVE_DOT is set to YES.
1220 2531
1221COLLABORATION_GRAPH = YES 2532COLLABORATION_GRAPH = YES
1222 2533
1223# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 2534# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
1224# will generate a graph for groups, showing the direct groups dependencies 2535# groups, showing the direct groups dependencies. Explicit enabling a group
2536# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
2537# of the command \groupgraph. Disabling a directory graph can be accomplished by
2538# means of the command \hidegroupgraph. See also the chapter Grouping in the
2539# manual.
2540# The default value is: YES.
2541# This tag requires that the tag HAVE_DOT is set to YES.
1225 2542
1226GROUP_GRAPHS = YES 2543GROUP_GRAPHS = YES
1227 2544
1228# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 2545# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
1229# collaboration diagrams in a style similar to the OMG's Unified Modeling 2546# collaboration diagrams in a style similar to the OMG's Unified Modeling
1230# Language. 2547# Language.
2548# The default value is: NO.
2549# This tag requires that the tag HAVE_DOT is set to YES.
1231 2550
1232UML_LOOK = NO 2551UML_LOOK = NO
1233 2552
1234# If set to YES, the inheritance and collaboration graphs will show the 2553# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
1235# relations between templates and their instances. 2554# class node. If there are many fields or methods and many nodes the graph may
2555# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2556# number of items for each type to make the size more manageable. Set this to 0
2557# for no limit. Note that the threshold may be exceeded by 50% before the limit
2558# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2559# but if the number exceeds 15, the total amount of fields shown is limited to
2560# 10.
2561# Minimum value: 0, maximum value: 100, default value: 10.
2562# This tag requires that the tag UML_LOOK is set to YES.
2563
2564UML_LIMIT_NUM_FIELDS = 10
2565
2566# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2567# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2568# tag is set to YES, doxygen will add type and arguments for attributes and
2569# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2570# will not generate fields with class member information in the UML graphs. The
2571# class diagrams will look similar to the default class diagrams but using UML
2572# notation for the relationships.
2573# Possible values are: NO, YES and NONE.
2574# The default value is: NO.
2575# This tag requires that the tag UML_LOOK is set to YES.
2576
2577DOT_UML_DETAILS = NO
2578
2579# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2580# to display on a single line. If the actual line length exceeds this threshold
2581# significantly it will be wrapped across multiple lines. Some heuristics are
2582# applied to avoid ugly line breaks.
2583# Minimum value: 0, maximum value: 1000, default value: 17.
2584# This tag requires that the tag HAVE_DOT is set to YES.
2585
2586DOT_WRAP_THRESHOLD = 17
2587
2588# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2589# collaboration graphs will show the relations between templates and their
2590# instances.
2591# The default value is: NO.
2592# This tag requires that the tag HAVE_DOT is set to YES.
1236 2593
1237TEMPLATE_RELATIONS = NO 2594TEMPLATE_RELATIONS = NO
1238 2595
1239# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 2596# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
1240# tags are set to YES then doxygen will generate a graph for each documented 2597# YES then doxygen will generate a graph for each documented file showing the
1241# file showing the direct and indirect include dependencies of the file with 2598# direct and indirect include dependencies of the file with other documented
1242# other documented files. 2599# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO,
2600# can be accomplished by means of the command \includegraph. Disabling an
2601# include graph can be accomplished by means of the command \hideincludegraph.
2602# The default value is: YES.
2603# This tag requires that the tag HAVE_DOT is set to YES.
1243 2604
1244INCLUDE_GRAPH = YES 2605INCLUDE_GRAPH = YES
1245 2606
1246# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 2607# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
1247# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 2608# set to YES then doxygen will generate a graph for each documented file showing
1248# documented header file showing the documented files that directly or 2609# the direct and indirect include dependencies of the file with other documented
1249# indirectly include this file. 2610# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
2611# to NO, can be accomplished by means of the command \includedbygraph. Disabling
2612# an included by graph can be accomplished by means of the command
2613# \hideincludedbygraph.
2614# The default value is: YES.
2615# This tag requires that the tag HAVE_DOT is set to YES.
1250 2616
1251INCLUDED_BY_GRAPH = YES 2617INCLUDED_BY_GRAPH = YES
1252 2618
1253# If the CALL_GRAPH and HAVE_DOT options are set to YES then 2619# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
1254# doxygen will generate a call dependency graph for every global function 2620# dependency graph for every global function or class method.
1255# or class method. Note that enabling this option will significantly increase 2621#
1256# the time of a run. So in most cases it will be better to enable call graphs 2622# Note that enabling this option will significantly increase the time of a run.
1257# for selected functions only using the \callgraph command. 2623# So in most cases it will be better to enable call graphs for selected
2624# functions only using the \callgraph command. Disabling a call graph can be
2625# accomplished by means of the command \hidecallgraph.
2626# The default value is: NO.
2627# This tag requires that the tag HAVE_DOT is set to YES.
1258 2628
1259CALL_GRAPH = NO 2629CALL_GRAPH = NO
1260 2630
1261# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 2631# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
1262# doxygen will generate a caller dependency graph for every global function 2632# dependency graph for every global function or class method.
1263# or class method. Note that enabling this option will significantly increase 2633#
1264# the time of a run. So in most cases it will be better to enable caller 2634# Note that enabling this option will significantly increase the time of a run.
1265# graphs for selected functions only using the \callergraph command. 2635# So in most cases it will be better to enable caller graphs for selected
2636# functions only using the \callergraph command. Disabling a caller graph can be
2637# accomplished by means of the command \hidecallergraph.
2638# The default value is: NO.
2639# This tag requires that the tag HAVE_DOT is set to YES.
1266 2640
1267CALLER_GRAPH = NO 2641CALLER_GRAPH = NO
1268 2642
1269# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 2643# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
1270# will graphical hierarchy of all classes instead of a textual one. 2644# hierarchy of all classes instead of a textual one.
2645# The default value is: YES.
2646# This tag requires that the tag HAVE_DOT is set to YES.
1271 2647
1272GRAPHICAL_HIERARCHY = YES 2648GRAPHICAL_HIERARCHY = YES
1273 2649
1274# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 2650# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
1275# then doxygen will show the dependencies a directory has on other directories 2651# dependencies a directory has on other directories in a graphical way. The
1276# in a graphical way. The dependency relations are determined by the #include 2652# dependency relations are determined by the #include relations between the
1277# relations between the files in the directories. 2653# files in the directories. Explicit enabling a directory graph, when
2654# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
2655# \directorygraph. Disabling a directory graph can be accomplished by means of
2656# the command \hidedirectorygraph.
2657# The default value is: YES.
2658# This tag requires that the tag HAVE_DOT is set to YES.
1278 2659
1279DIRECTORY_GRAPH = YES 2660DIRECTORY_GRAPH = YES
1280 2661
1281# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2662# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
1282# generated by dot. Possible values are png, jpg, or gif 2663# of child directories generated in directory dependency graphs by dot.
1283# If left blank png will be used. 2664# Minimum value: 1, maximum value: 25, default value: 1.
2665# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2666
2667DIR_GRAPH_MAX_DEPTH = 1
2668
2669# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2670# generated by dot. For an explanation of the image formats see the section
2671# output formats in the documentation of the dot tool (Graphviz (see:
2672# https://www.graphviz.org/)).
2673# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2674# to make the SVG files visible in IE 9+ (other browsers do not have this
2675# requirement).
2676# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2677# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2678# png:gdiplus:gdiplus.
2679# The default value is: png.
2680# This tag requires that the tag HAVE_DOT is set to YES.
1284 2681
1285DOT_IMAGE_FORMAT = png 2682DOT_IMAGE_FORMAT = png
1286 2683
1287# The tag DOT_PATH can be used to specify the path where the dot tool can be 2684# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2685# enable generation of interactive SVG images that allow zooming and panning.
2686#
2687# Note that this requires a modern browser other than Internet Explorer. Tested
2688# and working are Firefox, Chrome, Safari, and Opera.
2689# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2690# the SVG files visible. Older versions of IE do not have SVG support.
2691# The default value is: NO.
2692# This tag requires that the tag HAVE_DOT is set to YES.
2693
2694INTERACTIVE_SVG = NO
2695
2696# The DOT_PATH tag can be used to specify the path where the dot tool can be
1288# found. If left blank, it is assumed the dot tool can be found in the path. 2697# found. If left blank, it is assumed the dot tool can be found in the path.
2698# This tag requires that the tag HAVE_DOT is set to YES.
2699
2700DOT_PATH =
2701
2702# The DOTFILE_DIRS tag can be used to specify one or more directories that
2703# contain dot files that are included in the documentation (see the \dotfile
2704# command).
2705# This tag requires that the tag HAVE_DOT is set to YES.
2706
2707DOTFILE_DIRS =
2708
2709# You can include diagrams made with dia in doxygen documentation. Doxygen will
2710# then run dia to produce the diagram and insert it in the documentation. The
2711# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2712# If left empty dia is assumed to be found in the default search path.
2713
2714DIA_PATH =
2715
2716# The DIAFILE_DIRS tag can be used to specify one or more directories that
2717# contain dia files that are included in the documentation (see the \diafile
2718# command).
2719
2720DIAFILE_DIRS =
2721
2722# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2723# path where java can find the plantuml.jar file or to the filename of jar file
2724# to be used. If left blank, it is assumed PlantUML is not used or called during
2725# a preprocessing step. Doxygen will generate a warning when it encounters a
2726# \startuml command in this case and will not generate output for the diagram.
2727
2728PLANTUML_JAR_PATH =
1289 2729
1290DOT_PATH = 2730# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2731# configuration file for plantuml.
1291 2732
1292# The DOTFILE_DIRS tag can be used to specify one or more directories that 2733PLANTUML_CFG_FILE =
1293# contain dot files that are included in the documentation (see the
1294# \dotfile command).
1295 2734
1296DOTFILE_DIRS = 2735# When using plantuml, the specified paths are searched for files specified by
2736# the !include statement in a plantuml block.
1297 2737
1298# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 2738PLANTUML_INCLUDE_PATH =
1299# nodes that will be shown in the graph. If the number of nodes in a graph 2739
1300# becomes larger than this value, doxygen will truncate the graph, which is 2740# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
1301# visualized by representing a node as a red box. Note that doxygen if the 2741# that will be shown in the graph. If the number of nodes in a graph becomes
1302# number of direct children of the root node in a graph is already larger than 2742# larger than this value, doxygen will truncate the graph, which is visualized
1303# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 2743# by representing a node as a red box. Note that if the number of direct
1304# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2744# children of the root node in a graph is already larger than
2745# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2746# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2747# Minimum value: 0, maximum value: 10000, default value: 50.
2748# This tag requires that the tag HAVE_DOT is set to YES.
1305 2749
1306DOT_GRAPH_MAX_NODES = 50 2750DOT_GRAPH_MAX_NODES = 50
1307 2751
1308# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 2752# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
1309# graphs generated by dot. A depth value of 3 means that only nodes reachable 2753# generated by dot. A depth value of 3 means that only nodes reachable from the
1310# from the root by following a path via at most 3 edges will be shown. Nodes 2754# root by following a path via at most 3 edges will be shown. Nodes that lay
1311# that lay further from the root node will be omitted. Note that setting this 2755# further from the root node will be omitted. Note that setting this option to 1
1312# option to 1 or 2 may greatly reduce the computation time needed for large 2756# or 2 may greatly reduce the computation time needed for large code bases. Also
1313# code bases. Also note that the size of a graph can be further restricted by 2757# note that the size of a graph can be further restricted by
1314# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2758# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2759# Minimum value: 0, maximum value: 1000, default value: 0.
2760# This tag requires that the tag HAVE_DOT is set to YES.
1315 2761
1316MAX_DOT_GRAPH_DEPTH = 0 2762MAX_DOT_GRAPH_DEPTH = 0
1317 2763
1318# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 2764# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
1319# background. This is enabled by default, which results in a transparent 2765# files in one run (i.e. multiple -o and -T options on the command line). This
1320# background. Warning: Depending on the platform used, enabling this option 2766# makes dot run faster, but since only newer versions of dot (>1.8.10) support
1321# may lead to badly anti-aliased labels on the edges of a graph (i.e. they 2767# this, this feature is disabled by default.
1322# become hard to read). 2768# The default value is: NO.
1323 2769# This tag requires that the tag HAVE_DOT is set to YES.
1324DOT_TRANSPARENT = NO
1325
1326# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1327# files in one run (i.e. multiple -o and -T options on the command line). This
1328# makes dot run faster, but since only newer versions of dot (>1.8.10)
1329# support this, this feature is disabled by default.
1330 2770
1331DOT_MULTI_TARGETS = NO 2771DOT_MULTI_TARGETS = NO
1332 2772
1333# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 2773# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
1334# generate a legend page explaining the meaning of the various boxes and 2774# explaining the meaning of the various boxes and arrows in the dot generated
1335# arrows in the dot generated graphs. 2775# graphs.
2776# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
2777# graphical representation for inheritance and collaboration diagrams is used.
2778# The default value is: YES.
2779# This tag requires that the tag HAVE_DOT is set to YES.
1336 2780
1337GENERATE_LEGEND = YES 2781GENERATE_LEGEND = YES
1338 2782
1339# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 2783# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
1340# remove the intermediate dot files that are used to generate 2784# files that are used to generate the various graphs.
1341# the various graphs. 2785#
2786# Note: This setting is not only used for dot files but also for msc temporary
2787# files.
2788# The default value is: YES.
1342 2789
1343DOT_CLEANUP = YES 2790DOT_CLEANUP = YES
1344 2791
1345#--------------------------------------------------------------------------- 2792# You can define message sequence charts within doxygen comments using the \msc
1346# Configuration::additions related to the search engine 2793# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will
1347#--------------------------------------------------------------------------- 2794# use a built-in version of mscgen tool to produce the charts. Alternatively,
2795# the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
2796# specifying prog as the value, doxygen will call the tool as prog -T
2797# <outfile_format> -o <outputfile> <inputfile>. The external tool should support
2798# output file formats "png", "eps", "svg", and "ismap".
1348 2799
1349# The SEARCHENGINE tag specifies whether or not a search engine should be 2800MSCGEN_TOOL =
1350# used. If set to NO the values of all tags below this one will be ignored.
1351 2801
1352SEARCHENGINE = NO 2802# The MSCFILE_DIRS tag can be used to specify one or more directories that
2803# contain msc files that are included in the documentation (see the \mscfile
2804# command).
2805
2806MSCFILE_DIRS =