diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 11 | ||||
| -rw-r--r-- | doc/config.doc | 14 | ||||
| -rw-r--r-- | doc/doxytag_usage.doc | 2 | ||||
| -rw-r--r-- | doc/external.doc | 9 | ||||
| -rw-r--r-- | doc/faq.doc | 36 | ||||
| -rw-r--r-- | doc/infoflow.eps | 665 | ||||
| -rw-r--r-- | doc/infoflow.fig | 250 | ||||
| -rw-r--r-- | doc/infoflow.gif | bin | 0 -> 13193 bytes | |||
| -rw-r--r-- | doc/language.doc | 2 | ||||
| -rw-r--r-- | doc/starting.doc | 6 |
10 files changed, 986 insertions, 9 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 7e96292..2477479 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -1796,4 +1796,15 @@ browser generator. Do \e not use these commands in your own documentation. <li>\\postheader </ul> +For PHP files there are a number of additional commands, that can be +used inside classes to make members public, private, or protected even +though the language itself doesn't support this notion. + +To mark a single item use one of \\private, \\protected, \\public. +For starting a section with a certain protection level use one of: +\\privatesection, \\protectedsection, \\publicsection. +The latter commands are similar to +"private:", "protected:", and "public:" in C++. + */ + diff --git a/doc/config.doc b/doc/config.doc index 6419e6e..653360a 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -363,13 +363,6 @@ function's detailed documentation block. to \c NO (the default) then the documentation will be excluded. Set it to \c YES to include the internal documentation. -\anchor cfg_strip_code_comments -<dt>\c STRIP_CODE_COMMENTS <dd> - \addindex STRIP_CODE_COMMENTS - Setting the \c STRIP_CODE_COMMENTS tag to \c YES (the default) will instruct - doxygen to hide any special comment blocks from generated source code - fragments. Normal C and C++ comments will always remain visible. - \anchor cfg_case_sense_names <dt>\c CASE_SENSE_NAMES <dd> \addindex CASE_SENSE_NAMES @@ -730,6 +723,13 @@ function's detailed documentation block. Setting the \c INLINE_SOURCES tag to \c YES will include the body of functions, classes and enums directly into the documentation. +\anchor cfg_strip_code_comments +<dt>\c STRIP_CODE_COMMENTS <dd> + \addindex STRIP_CODE_COMMENTS + Setting the \c STRIP_CODE_COMMENTS tag to \c YES (the default) will instruct + doxygen to hide any special comment blocks from generated source code + fragments. Normal C and C++ comments will always remain visible. + \anchor cfg_referenced_by_relation <dt>\c REFERENCED_BY_RELATION <dd> \addindex REFERENCED_BY_RELATION diff --git a/doc/doxytag_usage.doc b/doc/doxytag_usage.doc index 187c285..76ae8b7 100644 --- a/doc/doxytag_usage.doc +++ b/doc/doxytag_usage.doc @@ -103,7 +103,7 @@ doxytag -t example.tag example/html \par Example 2: To generate a tag file of the Qt documentation you can do the following: \verbatim -doxytag -t qt.tag $QTDIR/html +doxytag -t qt.tag $QTDIR/doc/html \endverbatim A typical example to use doxytag to generate a search index is: diff --git a/doc/external.doc b/doc/external.doc index e7d3bf0..994bd7f 100644 --- a/doc/external.doc +++ b/doc/external.doc @@ -35,6 +35,15 @@ reasons to not include all sources for these with every run of doxygen: linked in externally. This saves a lot of memory. <dt>Availability:<dd> For some projects that are documented with doxygen, the sources may just not be available. +<dt>Copyright issues:<dd>If the external + package and its documentation are copyright someone else, it may be + better - or even necessary - to reference it rather than include a + copy of it with your project's documentation. When the author forbids + redistribution, this is necessary. If the author requires compliance + with some license condition as a precondition of redistribution, and + you do now want to be bound by those conditions, referring to their + copy of their documentation is preferable to including a copy. + </dl> If any of the above apply, you can use doxygen's tag file mechanism. diff --git a/doc/faq.doc b/doc/faq.doc index 576daaf..836da50 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -222,6 +222,42 @@ should send me a code fragment that triggers the message. The workaround the problem put some line-breaks into your file, split it up into smaller parts, or exclude it from the input using EXCLUDE. +<li><b>Why are dependencies via STL classes not shown in the dot graphs?</b> + +Doxygen is unware of the STL classes, so it does not know that class A relates +to class B in the following example + +\code +#include <vector> + +using namespace std; + +class B {}; + +class A +{ + public: + vector<B> m_bvec; +}; +\endcode + +To overcome this problem you could provide the definition of the vector +class to doxygen (by including the file that defines it at the INPUT tag +in the config file). Since STL header files are often messy, a +(possibly) better approach is to include a dummy definition of a vector +class to the input. Here is an example of a dummy STL file for the vector +class: + +\code +namespace std { + /*! STL vector class */ + template<class T> class vector { public: T element; }; +} +\endcode + +I'm still looking for someone who can provide me with definitions +for all (relevant) STL classes. + <li><b>How did doxygen get its name?</b> Doxygen got its name from playing with the words diff --git a/doc/infoflow.eps b/doc/infoflow.eps new file mode 100644 index 0000000..68735e9 --- /dev/null +++ b/doc/infoflow.eps @@ -0,0 +1,665 @@ +%!PS-Adobe-2.0 EPSF-2.0 +%%Title: infoflow.eps +%%Creator: fig2dev Version 3.2 Patchlevel 3c +%%CreationDate: Tue Dec 31 19:32:56 2002 +%%For: dimitri@pandora.home.nl (Dimitri van Heesch) +%%BoundingBox: 0 0 673 585 +%%Magnification: 1.0000 +%%EndComments +/$F2psDict 200 dict def +$F2psDict begin +$F2psDict /mtrx matrix put +/col-1 {0 setgray} bind def +/col0 {0.000 0.000 0.000 srgb} bind def +/col1 {0.000 0.000 1.000 srgb} bind def +/col2 {0.000 1.000 0.000 srgb} bind def +/col3 {0.000 1.000 1.000 srgb} bind def +/col4 {1.000 0.000 0.000 srgb} bind def +/col5 {1.000 0.000 1.000 srgb} bind def +/col6 {1.000 1.000 0.000 srgb} bind def +/col7 {1.000 1.000 1.000 srgb} bind def +/col8 {0.000 0.000 0.560 srgb} bind def +/col9 {0.000 0.000 0.690 srgb} bind def +/col10 {0.000 0.000 0.820 srgb} bind def +/col11 {0.530 0.810 1.000 srgb} bind def +/col12 {0.000 0.560 0.000 srgb} bind def +/col13 {0.000 0.690 0.000 srgb} bind def +/col14 {0.000 0.820 0.000 srgb} bind def +/col15 {0.000 0.560 0.560 srgb} bind def +/col16 {0.000 0.690 0.690 srgb} bind def +/col17 {0.000 0.820 0.820 srgb} bind def +/col18 {0.560 0.000 0.000 srgb} bind def +/col19 {0.690 0.000 0.000 srgb} bind def +/col20 {0.820 0.000 0.000 srgb} bind def +/col21 {0.560 0.000 0.560 srgb} bind def +/col22 {0.690 0.000 0.690 srgb} bind def +/col23 {0.820 0.000 0.820 srgb} bind def +/col24 {0.500 0.190 0.000 srgb} bind def +/col25 {0.630 0.250 0.000 srgb} bind def +/col26 {0.750 0.380 0.000 srgb} bind def +/col27 {1.000 0.500 0.500 srgb} bind def +/col28 {1.000 0.630 0.630 srgb} bind def +/col29 {1.000 0.750 0.750 srgb} bind def +/col30 {1.000 0.880 0.880 srgb} bind def +/col31 {1.000 0.840 0.000 srgb} bind def +/col32 {0.878 0.878 0.878 srgb} bind def +/col33 {0.000 0.000 0.000 srgb} bind def + +end +save +newpath 0 585 moveto 0 0 lineto 673 0 lineto 673 585 lineto closepath clip newpath +-39.0 602.0 translate +1 -1 scale + +/cp {closepath} bind def +/ef {eofill} bind def +/gr {grestore} bind def +/gs {gsave} bind def +/sa {save} bind def +/rs {restore} bind def +/l {lineto} bind def +/m {moveto} bind def +/rm {rmoveto} bind def +/n {newpath} bind def +/s {stroke} bind def +/sh {show} bind def +/slc {setlinecap} bind def +/slj {setlinejoin} bind def +/slw {setlinewidth} bind def +/srgb {setrgbcolor} bind def +/rot {rotate} bind def +/sc {scale} bind def +/sd {setdash} bind def +/ff {findfont} bind def +/sf {setfont} bind def +/scf {scalefont} bind def +/sw {stringwidth} bind def +/tr {translate} bind def +/tnt {dup dup currentrgbcolor + 4 -2 roll dup 1 exch sub 3 -1 roll mul add + 4 -2 roll dup 1 exch sub 3 -1 roll mul add + 4 -2 roll dup 1 exch sub 3 -1 roll mul add srgb} + bind def +/shd {dup dup currentrgbcolor 4 -2 roll mul 4 -2 roll mul + 4 -2 roll mul srgb} bind def +/reencdict 12 dict def /ReEncode { reencdict begin +/newcodesandnames exch def /newfontname exch def /basefontname exch def +/basefontdict basefontname findfont def /newfont basefontdict maxlength dict def +basefontdict { exch dup /FID ne { dup /Encoding eq +{ exch dup length array copy newfont 3 1 roll put } +{ exch newfont 3 1 roll put } ifelse } { pop pop } ifelse } forall +newfont /FontName newfontname put newcodesandnames aload pop +128 1 255 { newfont /Encoding get exch /.notdef put } for +newcodesandnames length 2 idiv { newfont /Encoding get 3 1 roll put } repeat +newfontname newfont definefont pop end } def +/isovec [ +8#055 /minus 8#200 /grave 8#201 /acute 8#202 /circumflex 8#203 /tilde +8#204 /macron 8#205 /breve 8#206 /dotaccent 8#207 /dieresis +8#210 /ring 8#211 /cedilla 8#212 /hungarumlaut 8#213 /ogonek 8#214 /caron +8#220 /dotlessi 8#230 /oe 8#231 /OE +8#240 /space 8#241 /exclamdown 8#242 /cent 8#243 /sterling +8#244 /currency 8#245 /yen 8#246 /brokenbar 8#247 /section 8#250 /dieresis +8#251 /copyright 8#252 /ordfeminine 8#253 /guillemotleft 8#254 /logicalnot +8#255 /hyphen 8#256 /registered 8#257 /macron 8#260 /degree 8#261 /plusminus +8#262 /twosuperior 8#263 /threesuperior 8#264 /acute 8#265 /mu 8#266 /paragraph +8#267 /periodcentered 8#270 /cedilla 8#271 /onesuperior 8#272 /ordmasculine +8#273 /guillemotright 8#274 /onequarter 8#275 /onehalf +8#276 /threequarters 8#277 /questiondown 8#300 /Agrave 8#301 /Aacute +8#302 /Acircumflex 8#303 /Atilde 8#304 /Adieresis 8#305 /Aring +8#306 /AE 8#307 /Ccedilla 8#310 /Egrave 8#311 /Eacute +8#312 /Ecircumflex 8#313 /Edieresis 8#314 /Igrave 8#315 /Iacute +8#316 /Icircumflex 8#317 /Idieresis 8#320 /Eth 8#321 /Ntilde 8#322 /Ograve +8#323 /Oacute 8#324 /Ocircumflex 8#325 /Otilde 8#326 /Odieresis 8#327 /multiply +8#330 /Oslash 8#331 /Ugrave 8#332 /Uacute 8#333 /Ucircumflex +8#334 /Udieresis 8#335 /Yacute 8#336 /Thorn 8#337 /germandbls 8#340 /agrave +8#341 /aacute 8#342 /acircumflex 8#343 /atilde 8#344 /adieresis 8#345 /aring +8#346 /ae 8#347 /ccedilla 8#350 /egrave 8#351 /eacute +8#352 /ecircumflex 8#353 /edieresis 8#354 /igrave 8#355 /iacute +8#356 /icircumflex 8#357 /idieresis 8#360 /eth 8#361 /ntilde 8#362 /ograve +8#363 /oacute 8#364 /ocircumflex 8#365 /otilde 8#366 /odieresis 8#367 /divide +8#370 /oslash 8#371 /ugrave 8#372 /uacute 8#373 /ucircumflex +8#374 /udieresis 8#375 /yacute 8#376 /thorn 8#377 /ydieresis] def +/Times-Roman /Times-Roman-iso isovec ReEncode +/$F2psBegin {$F2psDict begin /$F2psEnteredState save def} def +/$F2psEnd {$F2psEnteredState restore end} def + +$F2psBegin +%%Page: 1 1 +10 setmiterlimit + 0.06000 0.06000 sc +% +% Fig objects follow +% +% Polyline +7.500 slw +n 3600 1950 m 3900 1650 l 4800 1650 l 4800 3150 l 3600 3150 l 3600 1950 l + 3900 1950 l + 3900 1650 l gs col0 s gr +/Times-Roman-iso ff 180.00 scf sf +3900 2250 m +gs 1 -1 sc (Config file) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +3900 2550 m +gs 1 -1 sc (Doxyfile) col0 sh gr +% Polyline +n 900 7500 m 1200 7200 l 2100 7200 l 2100 8700 l 900 8700 l 900 7500 l + 1200 7500 l + 1200 7200 l gs col0 s gr +/Times-Roman-iso ff 180.00 scf sf +1200 7950 m +gs 1 -1 sc (search) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +1200 8175 m +gs 1 -1 sc (index) col0 sh gr +% Polyline +n 900 3675 m 1200 3375 l 2100 3375 l 2100 4875 l 900 4875 l 900 3675 l + 1200 3675 l + 1200 3375 l gs col0 s gr +% Polyline +n 975 3600 m 975 3300 l 2175 3300 l 2175 4800 l + 2100 4800 l gs col0 s gr +% Polyline +n 1050 3300 m 1050 3225 l 2250 3225 l 2250 4725 l + 2175 4725 l gs col0 s gr +% Polyline +n 1125 3225 m 1125 3150 l 2325 3150 l 2325 4650 l + 2250 4650 l gs col0 s gr +% Polyline +n 900 5700 m 1200 5400 l 2100 5400 l 2100 6900 l 900 6900 l 900 5700 l + 1200 5700 l + 1200 5400 l gs col0 s gr +% Polyline +n 975 5625 m 975 5325 l 2175 5325 l 2175 6825 l + 2100 6825 l gs col0 s gr +% Polyline +n 1050 5325 m 1050 5250 l 2250 5250 l 2250 6750 l + 2175 6750 l gs col0 s gr +% Polyline +n 1125 5250 m 1125 5175 l 2325 5175 l 2325 6675 l + 2250 6675 l gs col0 s gr +/Times-Roman-iso ff 180.00 scf sf +1275 6075 m +gs 1 -1 sc (- headers) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +1275 6675 m +gs 1 -1 sc (- images) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +1275 6375 m +gs 1 -1 sc (- footers) col0 sh gr +% Polyline +n 6675 8775 m 6975 8475 l 7875 8475 l 7875 9975 l 6675 9975 l 6675 8775 l + 6975 8775 l + 6975 8475 l gs col0 s gr +% Polyline +n 6750 8700 m 6750 8400 l 7950 8400 l 7950 9900 l + 7875 9900 l gs col0 s gr +% Polyline +n 6825 8400 m 6825 8325 l 8025 8325 l 8025 9825 l + 7950 9825 l gs col0 s gr +% Polyline +n 6900 8325 m 6900 8250 l 8100 8250 l 8100 9750 l + 8025 9750 l gs col0 s gr +% Polyline +n 6600 4950 m 6900 4650 l 7800 4650 l 7800 6150 l 6600 6150 l 6600 4950 l + 6900 4950 l + 6900 4650 l gs col0 s gr +% Polyline +n 6675 4875 m 6675 4575 l 7875 4575 l 7875 6075 l + 7800 6075 l gs col0 s gr +% Polyline +n 6750 4575 m 6750 4500 l 7950 4500 l 7950 6000 l + 7875 6000 l gs col0 s gr +% Polyline +n 6825 4500 m 6825 4425 l 8025 4425 l 8025 5925 l + 7950 5925 l gs col0 s gr +% Polyline +n 6600 2925 m 6900 2625 l 7800 2625 l 7800 4125 l 6600 4125 l 6600 2925 l + 6900 2925 l + 6900 2625 l gs col0 s gr +% Polyline +n 6675 2850 m 6675 2550 l 7875 2550 l 7875 4050 l + 7800 4050 l gs col0 s gr +% Polyline +n 6750 2550 m 6750 2475 l 7950 2475 l 7950 3975 l + 7875 3975 l gs col0 s gr +% Polyline +n 6825 2475 m 6825 2400 l 8025 2400 l 8025 3900 l + 7950 3900 l gs col0 s gr +% Polyline +n 6600 900 m 6900 600 l 7800 600 l 7800 2100 l 6600 2100 l 6600 900 l + 6900 900 l + 6900 600 l gs col0 s gr +% Polyline +n 6675 825 m 6675 525 l 7875 525 l 7875 2025 l + 7800 2025 l gs col0 s gr +% Polyline +n 6750 525 m 6750 450 l 7950 450 l 7950 1950 l + 7875 1950 l gs col0 s gr +% Polyline +n 6825 450 m 6825 375 l 8025 375 l 8025 1875 l + 7950 1875 l gs col0 s gr +% Polyline +gs clippath +4020 3765 m 4080 3765 l 4080 3614 l 4050 3734 l 4020 3614 l cp +eoclip +n 4050 3150 m + 4050 3750 l gs col0 s gr gr + +% arrowhead +n 4020 3614 m 4050 3734 l 4080 3614 l 4020 3614 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +3315 4155 m 3315 4095 l 3164 4095 l 3284 4125 l 3164 4155 l cp +eoclip +n 2100 4125 m + 3300 4125 l gs col0 s gr gr + +% arrowhead +n 3164 4155 m 3284 4125 l 3164 4095 l 3164 4155 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +3315 4380 m 3315 4320 l 3164 4320 l 3284 4350 l 3164 4380 l cp +eoclip +n 2100 6225 m 2700 6225 l 2700 4350 l + 3300 4350 l gs col0 s gr gr + +% arrowhead +n 3164 4380 m 3284 4350 l 3164 4320 l 3164 4380 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +4380 3135 m 4320 3135 l 4320 3286 l 4350 3166 l 4380 3286 l cp +eoclip +n 4350 3150 m + 4350 3750 l gs col0 s gr gr + +% arrowhead +n 4380 3286 m 4350 3166 l 4320 3286 l 4380 3286 l cp gs 0.00 setgray ef gr col0 s +% Polyline +n 3675 5925 m 3975 5625 l 4875 5625 l 4875 7125 l 3675 7125 l 3675 5925 l + 3975 5925 l + 3975 5625 l gs col0 s gr +% Polyline +n 3300 300 m 5100 300 l 5100 1050 l 3300 1050 l + cp gs col32 1.00 shd ef gr gs col0 s gr +% Polyline +gs clippath +4155 4635 m 4095 4635 l 4095 4786 l 4125 4666 l 4155 4786 l cp +eoclip +n 4125 5625 m + 4125 4650 l gs col0 s gr gr + +% arrowhead +n 4155 4786 m 4125 4666 l 4095 4786 l 4155 4786 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +4320 5640 m 4380 5640 l 4380 5489 l 4350 5609 l 4320 5489 l cp +eoclip +n 4350 5625 m + 4350 4650 l gs col0 s gr gr + +% arrowhead +n 4320 5489 m 4350 5609 l 4380 5489 l 4320 5489 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +4170 1665 m 4230 1665 l 4230 1514 l 4200 1634 l 4170 1514 l cp +4230 1035 m 4170 1035 l 4170 1186 l 4200 1066 l 4230 1186 l cp +eoclip +n 4200 1050 m + 4200 1650 l gs col0 s gr gr + +% arrowhead +n 4230 1186 m 4200 1066 l 4170 1186 l 4230 1186 l cp gs 0.00 setgray ef gr col0 s +% arrowhead +n 4170 1514 m 4200 1634 l 4230 1514 l 4170 1514 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +6615 1455 m 6615 1395 l 6464 1395 l 6584 1425 l 6464 1455 l cp +eoclip +n 5100 3900 m 6000 3900 l 6000 1425 l + 6600 1425 l gs col0 s gr gr + +% arrowhead +n 6464 1455 m 6584 1425 l 6464 1395 l 6464 1455 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +6615 3480 m 6615 3420 l 6464 3420 l 6584 3450 l 6464 3480 l cp +eoclip +n 5100 4050 m 6300 4050 l 6300 3450 l + 6600 3450 l gs col0 s gr gr + +% arrowhead +n 6464 3480 m 6584 3450 l 6464 3420 l 6464 3480 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +6615 5580 m 6615 5520 l 6464 5520 l 6584 5550 l 6464 5580 l cp +eoclip +n 5100 4200 m 6300 4200 l 6300 5550 l + 6600 5550 l gs col0 s gr gr + +% arrowhead +n 6464 5580 m 6584 5550 l 6464 5520 l 6464 5580 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +6690 7380 m 6690 7320 l 6539 7320 l 6659 7350 l 6539 7380 l cp +eoclip +n 5100 4350 m 6000 4350 l 6000 7350 l + 6675 7350 l gs col0 s gr gr + +% arrowhead +n 6539 7380 m 6659 7350 l 6539 7320 l 6539 7380 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +6690 9180 m 6690 9120 l 6539 9120 l 6659 9150 l 6539 9180 l cp +eoclip +n 5100 4500 m 5700 4500 l 5700 9150 l + 6675 9150 l gs col0 s gr gr + +% arrowhead +n 6539 9180 m 6659 9150 l 6539 9120 l 6539 9180 l cp gs 0.00 setgray ef gr col0 s +% Polyline +n 6675 6675 m 6975 6375 l 7875 6375 l 7875 7875 l 6675 7875 l 6675 6675 l + 6975 6675 l + 6975 6375 l gs col0 s gr +% Polyline +n 3300 3750 m 5100 3750 l 5100 4650 l 3300 4650 l + cp gs col32 1.00 shd ef gr gs col0 s gr +% Polyline +n 8775 450 m 10800 450 l 10800 1575 l 8775 1575 l + cp gs col32 1.00 shd ef gr gs col0 s gr +% Polyline +n 9075 900 m 10650 900 l 10650 1425 l 9075 1425 l + cp gs col0 s gr +% Polyline +gs clippath +8790 1380 m 8790 1320 l 8639 1320 l 8759 1350 l 8639 1380 l cp +eoclip +n 7800 1350 m + 8775 1350 l gs col0 s gr gr + +% arrowhead +n 8639 1380 m 8759 1350 l 8639 1320 l 8639 1380 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +11490 1380 m 11490 1320 l 11339 1320 l 11459 1350 l 11339 1380 l cp +eoclip +n 10800 1350 m + 11475 1350 l gs col0 s gr gr + +% arrowhead +n 11339 1380 m 11459 1350 l 11339 1320 l 11339 1380 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +9015 3180 m 9015 3120 l 8864 3120 l 8984 3150 l 8864 3180 l cp +eoclip +n 7800 3150 m + 9000 3150 l gs col0 s gr gr + +% arrowhead +n 8864 3180 m 8984 3150 l 8864 3120 l 8864 3180 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +9015 3555 m 9015 3495 l 8864 3495 l 8984 3525 l 8864 3555 l cp +eoclip +n 7800 3525 m + 9000 3525 l gs col0 s gr gr + +% arrowhead +n 8864 3555 m 8984 3525 l 8864 3495 l 8864 3555 l cp gs 0.00 setgray ef gr col0 s +% Polyline +n 9000 2925 m 10800 2925 l 10800 3675 l 9000 3675 l + cp gs col32 1.00 shd ef gr gs col0 s gr +% Polyline +gs clippath +11490 3180 m 11490 3120 l 11339 3120 l 11459 3150 l 11339 3180 l cp +eoclip +n 10800 3150 m + 11475 3150 l gs col0 s gr gr + +% arrowhead +n 11339 3180 m 11459 3150 l 11339 3120 l 11339 3180 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +11490 3555 m 11490 3495 l 11339 3495 l 11459 3525 l 11339 3555 l cp +eoclip +n 10800 3525 m + 11475 3525 l gs col0 s gr gr + +% arrowhead +n 11339 3555 m 11459 3525 l 11339 3495 l 11339 3555 l cp gs 0.00 setgray ef gr col0 s +% Polyline +n 9000 6900 m 10800 6900 l 10800 7650 l 9000 7650 l + cp gs col32 1.00 shd ef gr gs col0 s gr +% Polyline +gs clippath +9015 7305 m 9015 7245 l 8864 7245 l 8984 7275 l 8864 7305 l cp +eoclip +n 7875 7275 m + 9000 7275 l gs col0 s gr gr + +% arrowhead +n 8864 7305 m 8984 7275 l 8864 7245 l 8864 7305 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +11415 7305 m 11415 7245 l 11264 7245 l 11384 7275 l 11264 7305 l cp +eoclip +n 10800 7275 m + 11400 7275 l gs col0 s gr gr + +% arrowhead +n 11264 7305 m 11384 7275 l 11264 7245 l 11264 7305 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +9015 9180 m 9015 9120 l 8864 9120 l 8984 9150 l 8864 9180 l cp +eoclip +n 7875 9150 m + 9000 9150 l gs col0 s gr gr + +% arrowhead +n 8864 9180 m 8984 9150 l 8864 9120 l 8864 9180 l cp gs 0.00 setgray ef gr col0 s +% Polyline +n 9000 8775 m 10875 8775 l 10875 9525 l 9000 9525 l + cp gs col32 1.00 shd ef gr gs col0 s gr +% Polyline +gs clippath +11415 9180 m 11415 9120 l 11264 9120 l 11384 9150 l 11264 9180 l cp +eoclip +n 10875 9150 m + 11400 9150 l gs col0 s gr gr + +% arrowhead +n 11264 9180 m 11384 9150 l 11264 9120 l 11264 9180 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +4455 7110 m 4395 7110 l 4395 7261 l 4425 7141 l 4455 7261 l cp +eoclip +n 4425 8850 m + 4425 7125 l gs col0 s gr gr + +% arrowhead +n 4455 7261 m 4425 7141 l 4395 7261 l 4455 7261 l cp gs 0.00 setgray ef gr col0 s +% Polyline +n 3300 8850 m 5100 8850 l 5100 9525 l 3300 9525 l + cp gs col32 1.00 shd ef gr gs col0 s gr +% Polyline +gs clippath +5085 9270 m 5085 9330 l 5236 9330 l 5116 9300 l 5236 9270 l cp +eoclip +n 6675 9300 m + 5100 9300 l gs col0 s gr gr + +% arrowhead +n 5236 9270 m 5116 9300 l 5236 9330 l 5236 9270 l cp gs 0.00 setgray ef gr col0 s +% Polyline +n 675 9300 m 2475 9300 l 2475 9975 l 675 9975 l + cp gs col32 1.00 shd ef gr gs col0 s gr +% Polyline +gs clippath +2085 7995 m 2085 8055 l 2236 8055 l 2116 8025 l 2236 7995 l cp +eoclip +n 3900 8850 m 3900 8025 l + 2100 8025 l gs col0 s gr gr + +% arrowhead +n 2236 7995 m 2116 8025 l 2236 8055 l 2236 7995 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +1470 9315 m 1530 9315 l 1530 9164 l 1500 9284 l 1470 9164 l cp +eoclip +n 1500 8700 m + 1500 9300 l gs col0 s gr gr + +% arrowhead +n 1470 9164 m 1500 9284 l 1530 9164 l 1470 9164 l cp gs 0.00 setgray ef gr col0 s +% Polyline +gs clippath +6690 9780 m 6690 9720 l 6539 9720 l 6659 9750 l 6539 9780 l cp +2460 9720 m 2460 9780 l 2611 9780 l 2491 9750 l 2611 9720 l cp +eoclip +n 2475 9750 m + 6675 9750 l gs col0 s gr gr + +% arrowhead +n 2611 9720 m 2491 9750 l 2611 9780 l 2611 9720 l cp gs 0.00 setgray ef gr col0 s +% arrowhead +n 6539 9780 m 6659 9750 l 6539 9720 l 6539 9780 l cp gs 0.00 setgray ef gr col0 s +% Polyline + [60] 0 sd +n 8700 6450 m 11850 6450 l 11850 9975 l 8700 9975 l + cp gs col0 s gr [] 0 sd +/Times-Roman-iso ff 180.00 scf sf +4500 3525 m +gs 1 -1 sc (generate/update) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +3600 3525 m +gs 1 -1 sc (read) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +2850 3975 m +gs 1 -1 sc (read) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +2850 4650 m +gs 1 -1 sc (read) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +3975 6450 m +gs 1 -1 sc (Tag file\(s\)) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +3750 750 m +gs 1 -1 sc (Doxywizard) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +4425 5175 m +gs 1 -1 sc (generate) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +3675 5175 m +gs 1 -1 sc (read) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +4350 1425 m +gs 1 -1 sc (generate/edit) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +6900 1350 m +gs 1 -1 sc (XML files) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +6900 3300 m +gs 1 -1 sc (Latex files) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +6900 3750 m +gs 1 -1 sc (Makefile) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +7200 3525 m +gs 1 -1 sc (+) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +3900 4275 m +gs 1 -1 sc (Doxygen) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +9225 750 m +gs 1 -1 sc (Your application) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +9300 1275 m +gs 1 -1 sc (doxmlparser lib) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +8175 3750 m +gs 1 -1 sc (make pdf) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +8175 3000 m +gs 1 -1 sc (make ps) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +9675 3375 m +gs 1 -1 sc (latex) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +11025 825 m +gs 1 -1 sc (custom) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +11025 1050 m +gs 1 -1 sc (output) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +11025 3000 m +gs 1 -1 sc (postscript) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +11025 3825 m +gs 1 -1 sc (PDF) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +6900 7350 m +gs 1 -1 sc (refman.rtf) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +9525 7350 m +gs 1 -1 sc (MS-Word) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +11100 7200 m +gs 1 -1 sc (doc) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +8175 7200 m +gs 1 -1 sc (import) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +6975 9075 m +gs 1 -1 sc (HTML) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +6975 9300 m +gs 1 -1 sc (pages) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +9075 9225 m +gs 1 -1 sc (HTML Help Workshop) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +11100 9000 m +gs 1 -1 sc (chm) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +6825 5625 m +gs 1 -1 sc (Man pages) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +5475 9525 m +gs 1 -1 sc (parse) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +4575 8100 m +gs 1 -1 sc (generate) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +3825 9300 m +gs 1 -1 sc (Doxytag) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +1050 9750 m +gs 1 -1 sc (Doxysearch) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +1575 9075 m +gs 1 -1 sc (uses) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +2700 9975 m +gs 1 -1 sc (used from) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +5700 9975 m +gs 1 -1 sc (generates) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +8325 9075 m +gs 1 -1 sc (read) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +8775 6675 m +gs 1 -1 sc (Windows only) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +2700 8250 m +gs 1 -1 sc (generate) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +8250 1200 m +gs 1 -1 sc (read) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +1200 4200 m +gs 1 -1 sc (Sources) col0 sh gr +/Times-Roman-iso ff 180.00 scf sf +1275 5775 m +gs 1 -1 sc (Custom) col0 sh gr +$F2psEnd +rs diff --git a/doc/infoflow.fig b/doc/infoflow.fig new file mode 100644 index 0000000..01ede9a --- /dev/null +++ b/doc/infoflow.fig @@ -0,0 +1,250 @@ +#FIG 3.2 +Landscape +Center +Inches +Letter +100.00 +Single +-2 +1200 2 +0 32 #e0e0e0 +0 33 #000000 +6 3600 1650 4800 3150 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 8 + 3600 1950 3900 1650 4800 1650 4800 3150 3600 3150 3600 1950 + 3900 1950 3900 1650 +4 0 0 50 0 0 12 0.0000 4 180 780 3900 2250 Config file\001 +4 0 0 50 0 0 12 0.0000 4 180 645 3900 2550 Doxyfile\001 +-6 +6 900 7200 2100 8700 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 8 + 900 7500 1200 7200 2100 7200 2100 8700 900 8700 900 7500 + 1200 7500 1200 7200 +4 0 0 50 0 0 12 0.0000 4 135 510 1200 7950 search\001 +4 0 0 50 0 0 12 0.0000 4 135 405 1200 8175 index\001 +-6 +6 900 3150 2325 4875 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 8 + 900 3675 1200 3375 2100 3375 2100 4875 900 4875 900 3675 + 1200 3675 1200 3375 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 975 3600 975 3300 2175 3300 2175 4800 2100 4800 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 1050 3300 1050 3225 2250 3225 2250 4725 2175 4725 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 1125 3225 1125 3150 2325 3150 2325 4650 2250 4650 +-6 +6 900 5175 2325 6900 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 8 + 900 5700 1200 5400 2100 5400 2100 6900 900 6900 900 5700 + 1200 5700 1200 5400 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 975 5625 975 5325 2175 5325 2175 6825 2100 6825 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 1050 5325 1050 5250 2250 5250 2250 6750 2175 6750 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 1125 5250 1125 5175 2325 5175 2325 6675 2250 6675 +-6 +6 1275 5925 2025 6750 +4 0 0 50 0 0 12 0.0000 4 135 750 1275 6075 - headers\001 +4 0 0 50 0 0 12 0.0000 4 180 690 1275 6675 - images\001 +4 0 0 50 0 0 12 0.0000 4 135 690 1275 6375 - footers\001 +-6 +6 6675 8250 8100 9975 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 8 + 6675 8775 6975 8475 7875 8475 7875 9975 6675 9975 6675 8775 + 6975 8775 6975 8475 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 6750 8700 6750 8400 7950 8400 7950 9900 7875 9900 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 6825 8400 6825 8325 8025 8325 8025 9825 7950 9825 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 6900 8325 6900 8250 8100 8250 8100 9750 8025 9750 +-6 +6 6600 4425 8025 6150 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 8 + 6600 4950 6900 4650 7800 4650 7800 6150 6600 6150 6600 4950 + 6900 4950 6900 4650 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 6675 4875 6675 4575 7875 4575 7875 6075 7800 6075 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 6750 4575 6750 4500 7950 4500 7950 6000 7875 6000 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 6825 4500 6825 4425 8025 4425 8025 5925 7950 5925 +-6 +6 6600 2400 8025 4125 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 8 + 6600 2925 6900 2625 7800 2625 7800 4125 6600 4125 6600 2925 + 6900 2925 6900 2625 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 6675 2850 6675 2550 7875 2550 7875 4050 7800 4050 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 6750 2550 6750 2475 7950 2475 7950 3975 7875 3975 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 6825 2475 6825 2400 8025 2400 8025 3900 7950 3900 +-6 +6 6600 375 8025 2100 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 8 + 6600 900 6900 600 7800 600 7800 2100 6600 2100 6600 900 + 6900 900 6900 600 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 6675 825 6675 525 7875 525 7875 2025 7800 2025 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 6750 525 6750 450 7950 450 7950 1950 7875 1950 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 6825 450 6825 375 8025 375 8025 1875 7950 1875 +-6 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 4050 3150 4050 3750 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 2100 4125 3300 4125 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 4 + 1 1 1.00 60.00 120.00 + 2100 6225 2700 6225 2700 4350 3300 4350 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 1 2 + 1 1 1.00 60.00 120.00 + 4350 3150 4350 3750 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 8 + 3675 5925 3975 5625 4875 5625 4875 7125 3675 7125 3675 5925 + 3975 5925 3975 5625 +2 2 0 1 0 32 50 0 20 0.000 0 0 -1 0 0 5 + 3300 300 5100 300 5100 1050 3300 1050 3300 300 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 4125 5625 4125 4650 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 1 2 + 1 1 1.00 60.00 120.00 + 4350 5625 4350 4650 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 1 2 + 1 1 1.00 60.00 120.00 + 1 1 1.00 60.00 120.00 + 4200 1050 4200 1650 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 4 + 1 1 1.00 60.00 120.00 + 5100 3900 6000 3900 6000 1425 6600 1425 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 4 + 1 1 1.00 60.00 120.00 + 5100 4050 6300 4050 6300 3450 6600 3450 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 4 + 1 1 1.00 60.00 120.00 + 5100 4200 6300 4200 6300 5550 6600 5550 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 4 + 1 1 1.00 60.00 120.00 + 5100 4350 6000 4350 6000 7350 6675 7350 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 4 + 1 1 1.00 60.00 120.00 + 5100 4500 5700 4500 5700 9150 6675 9150 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 8 + 6675 6675 6975 6375 7875 6375 7875 7875 6675 7875 6675 6675 + 6975 6675 6975 6375 +2 2 0 1 0 32 50 0 20 0.000 0 0 -1 0 0 5 + 3300 3750 5100 3750 5100 4650 3300 4650 3300 3750 +2 2 0 1 0 32 50 0 20 0.000 0 0 -1 0 0 5 + 8775 450 10800 450 10800 1575 8775 1575 8775 450 +2 2 0 1 0 7 50 0 -1 0.000 0 0 -1 0 0 5 + 9075 900 10650 900 10650 1425 9075 1425 9075 900 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 7800 1350 8775 1350 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 10800 1350 11475 1350 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 7800 3150 9000 3150 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 7800 3525 9000 3525 +2 2 0 1 0 32 50 0 20 0.000 0 0 -1 0 0 5 + 9000 2925 10800 2925 10800 3675 9000 3675 9000 2925 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 10800 3150 11475 3150 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 10800 3525 11475 3525 +2 2 0 1 0 32 50 0 20 0.000 0 0 -1 0 0 5 + 9000 6900 10800 6900 10800 7650 9000 7650 9000 6900 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 7875 7275 9000 7275 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 10800 7275 11400 7275 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 7875 9150 9000 9150 +2 2 0 1 0 32 50 0 20 0.000 0 0 -1 0 0 5 + 9000 8775 10875 8775 10875 9525 9000 9525 9000 8775 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 10875 9150 11400 9150 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 4425 8850 4425 7125 +2 2 0 1 0 32 50 0 20 0.000 0 0 -1 0 0 5 + 3300 8850 5100 8850 5100 9525 3300 9525 3300 8850 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 6675 9300 5100 9300 +2 2 0 1 0 32 50 0 20 0.000 0 0 -1 0 0 5 + 675 9300 2475 9300 2475 9975 675 9975 675 9300 +2 1 0 1 0 7 50 0 -1 0.000 0 0 -1 1 0 3 + 1 1 1.00 60.00 120.00 + 3900 8850 3900 8025 2100 8025 +2 1 0 1 0 7 50 0 -1 4.000 0 0 -1 1 0 2 + 1 1 1.00 60.00 120.00 + 1500 8700 1500 9300 +2 1 0 1 0 7 50 0 -1 4.000 0 0 -1 1 1 2 + 1 1 1.00 60.00 120.00 + 1 1 1.00 60.00 120.00 + 2475 9750 6675 9750 +2 2 1 1 0 7 50 0 -1 4.000 0 0 -1 0 0 5 + 8700 6450 11850 6450 11850 9975 8700 9975 8700 6450 +4 0 0 50 0 0 12 0.0000 4 180 1215 4500 3525 generate/update\001 +4 0 0 50 0 0 12 0.0000 4 135 330 3600 3525 read\001 +4 0 0 50 0 0 12 0.0000 4 135 330 2850 3975 read\001 +4 0 0 50 0 0 12 0.0000 4 135 330 2850 4650 read\001 +4 0 0 50 0 0 12 0.0000 4 180 810 3975 6450 Tag file(s)\001 +4 0 0 50 0 0 12 0.0000 4 180 915 3750 750 Doxywizard\001 +4 0 0 50 0 0 12 0.0000 4 150 660 4425 5175 generate\001 +4 0 0 50 0 0 12 0.0000 4 135 330 3675 5175 read\001 +4 0 0 50 0 0 12 0.0000 4 180 990 4350 1425 generate/edit\001 +4 0 0 50 0 0 12 0.0000 4 135 780 6900 1350 XML files\001 +4 0 0 50 0 0 12 0.0000 4 135 810 6900 3300 Latex files\001 +4 0 0 50 0 0 12 0.0000 4 135 675 6900 3750 Makefile\001 +4 0 0 50 0 0 12 0.0000 4 75 105 7200 3525 +\001 +4 0 0 50 0 0 12 0.0000 4 180 675 3900 4275 Doxygen\001 +4 0 0 50 0 0 12 0.0000 4 180 1245 9225 750 Your application\001 +4 0 0 50 0 0 12 0.0000 4 180 1155 9300 1275 doxmlparser lib\001 +4 0 0 50 0 0 12 0.0000 4 180 690 8175 3750 make pdf\001 +4 0 0 50 0 0 12 0.0000 4 180 630 8175 3000 make ps\001 +4 0 0 50 0 0 12 0.0000 4 135 375 9675 3375 latex\001 +4 0 0 50 0 0 12 0.0000 4 105 555 11025 825 custom\001 +4 0 0 50 0 0 12 0.0000 4 150 480 11025 1050 output\001 +4 0 0 50 0 0 12 0.0000 4 180 765 11025 3000 postscript\001 +4 0 0 50 0 0 12 0.0000 4 135 345 11025 3825 PDF\001 +4 0 0 50 0 0 12 0.0000 4 135 750 6900 7350 refman.rtf\001 +4 0 0 50 0 0 12 0.0000 4 135 795 9525 7350 MS-Word\001 +4 0 0 50 0 0 12 0.0000 4 135 270 11100 7200 doc\001 +4 0 0 50 0 0 12 0.0000 4 180 480 8175 7200 import\001 +4 0 0 50 0 0 12 0.0000 4 135 510 6975 9075 HTML\001 +4 0 0 50 0 0 12 0.0000 4 135 450 6975 9300 pages\001 +4 0 0 50 0 0 12 0.0000 4 180 1740 9075 9225 HTML Help Workshop\001 +4 0 0 50 0 0 12 0.0000 4 135 315 11100 9000 chm\001 +4 0 0 50 0 0 12 0.0000 4 180 840 6825 5625 Man pages\001 +4 0 0 50 0 0 12 0.0000 4 135 420 5475 9525 parse\001 +4 0 0 50 0 0 12 0.0000 4 150 660 4575 8100 generate\001 +4 0 0 50 0 0 12 0.0000 4 180 645 3825 9300 Doxytag\001 +4 0 0 50 0 0 12 0.0000 4 180 915 1050 9750 Doxysearch\001 +4 0 0 50 0 0 12 0.0000 4 90 360 1575 9075 uses\001 +4 0 0 50 0 0 12 0.0000 4 135 750 2700 9975 used from\001 +4 0 0 50 0 0 12 0.0000 4 150 750 5700 9975 generates\001 +4 0 0 50 0 0 12 0.0000 4 135 330 8325 9075 read\001 +4 0 0 50 0 0 12 0.0000 4 180 1080 8775 6675 Windows only\001 +4 0 0 50 0 0 12 0.0000 4 150 660 2700 8250 generate\001 +4 0 0 50 0 0 12 0.0000 4 135 330 8250 1200 read\001 +4 0 0 50 0 0 12 0.0000 4 135 615 1200 4200 Sources\001 +4 0 0 50 0 0 12 0.0000 4 135 585 1275 5775 Custom\001 diff --git a/doc/infoflow.gif b/doc/infoflow.gif Binary files differnew file mode 100644 index 0000000..ae6bebb --- /dev/null +++ b/doc/infoflow.gif diff --git a/doc/language.doc b/doc/language.doc index bfacc39..27f4ec3 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -25,7 +25,7 @@ Doxygen has built-in support for multiple languages. This means that the text fragments that doxygen generates can be produced in languages other than English (the default) at configuration time. -Currently (version 1.2.14-20020317), 28 languages +Currently (version 1.3-rc2-20021224), 28 languages are supported (sorted alphabetically): Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, diff --git a/doc/starting.doc b/doc/starting.doc index 39bb117..c3b7065 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -32,6 +32,12 @@ engine. See section \ref doxysearch_usage for more detailed usage information. Optionally, the executable \c doxywizard is a GUI front-end for editing the configuration files that are used by doxygen. +The following figure shows the relation between the tools and the flow +of information between them: + +\image html infoflow.gif "Doxygen information flow" +\image latex infoflow.eps "Doxygen information flow" width=14cm + \section step1 Step 1: Creating a configuration file Doxygen uses a configuration file to determine all of its settings. |
