diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/arch.doc | 9 | ||||
| -rw-r--r-- | doc/commands.doc | 33 | ||||
| -rw-r--r-- | doc/config.doc | 2 | ||||
| -rw-r--r-- | doc/language.doc | 44 |
4 files changed, 61 insertions, 27 deletions
diff --git a/doc/arch.doc b/doc/arch.doc index 07cb781..47ff663 100644 --- a/doc/arch.doc +++ b/doc/arch.doc @@ -139,12 +139,13 @@ strings and executes the commands it finds in it (this is the second pass in parsing the documentation). It writes the result directly to the output generators. -The parser is written using \c flex and can be found in \c src/doc.l +The parser is written in C++ and can be found in src/docparser.cpp. The +tokens that are eaten by the parser come from src/doctokenizer.l. Code fragments found in the comment blocks are passed on to the source parser. -The main entry point for the documentation parser is \c parseDoc() -declared in \c src/doc.h. For simple texts with special -commands \c parseText() is used. +The main entry point for the documentation parser is \c validatingParseDoc() +declared in \c src/docparser.h. For simple texts with special +commands \c validatingParseText() is used. <h3>Source parser</h3> diff --git a/doc/commands.doc b/doc/commands.doc index e478a3e..3c764e2 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -129,6 +129,7 @@ documentation: \refitem cmdversion \\version \refitem cmdwarning \\warning \refitem cmdweakgroup \\weakgroup +\refitem cmdxrefitem \\xrefitem \refitem cmddollar \\\$ \refitem cmdat \\\@ \refitem cmdbackslash \\\\ @@ -1027,6 +1028,38 @@ ALIASES = "english=\if english" \ sectioning command is encountered. See section \ref cmdauthor "\\author" for an example. +\section cmdxrefitem \xrefitem <key> "(heading)" "(list title)" {text} + + \addindex \\xrefitem + This command is a generalization of commands such as \ref cmdtodo "\\todo" + and \ref cmdbug "\\bug". + It can be used to create user-defined text sections which are automatically + cross-referenced between the place of occurrence and a related page, + which will be generated. On the related page all sections of + the same type will be collected. + + The first argument \<key\> is a + identifier uniquely representing the type of the section. The second argument + is a quoted string representing the heading of the section under which + text passed as the forth argument is put. The third argument (list title) + is used as the title for the related page containing all items with the + same key. The keys "todo", "test", "bug", and "deprecated" are predefined. + + To get an idea on how to use the \\xrefitem command and what its effect + is, consider the todo list, which (for English output) can be seen an + alias for the command + \verbatim \xrefitem todo "Todo" "Todo List" \endverbatim + + Since it is very tedious and error-prone to repeat the first three + parameters of the command for each section, the command is meant to + be used in combination with the \ref cfg_aliases "ALIASES" option in the + configuration file. + To define a new command \\reminder, for instance, one should add the following + line to the configuration file: + \verbatim ALIASES += "reminder=\xrefitem reminders \"Reminder\" \"Reminders\"" \endverbatim + Note the use of escaped quotes for the second and third argument of the + \\xrefitem command. + <hr> <h2>\htmlonly <center> --- \endhtmlonly Commands to create links diff --git a/doc/config.doc b/doc/config.doc index 8cb2367..a5f8ae0 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -641,7 +641,7 @@ function's detailed documentation block. in the directories. If left blank the following patterns are tested: <code> *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp - *.h++ *.idl *.odl + *.h++ *.idl *.odl *.cs </code> \anchor cfg_recursive diff --git a/doc/language.doc b/doc/language.doc index 149686f..a93d603 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -55,7 +55,7 @@ when the translator was updated. <TD>Brazilian Portuguese</TD> <TD>Fabio "FJTC" Jun Takada Chino</TD> <TD>chino@NOSPAM.icmc.sc.usp.br</TD> - <TD>up-to-date</TD> + <TD>strange</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Catalan</TD> @@ -79,19 +79,19 @@ when the translator was updated. <TD>Croatian</TD> <TD>Boris Bralo</TD> <TD>boris.bralo@NOSPAM.zg.tel.hr</TD> - <TD>up-to-date</TD> + <TD>strange</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Czech</TD> <TD>Petr Přikryl</TD> <TD>prikrylp@NOSPAM.skil.cz</TD> - <TD>up-to-date</TD> + <TD>strange</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Danish</TD> <TD>Erik Søe Sørensen</TD> <TD>erik@NOSPAM.mail.nu</TD> - <TD>up-to-date</TD> + <TD>strange</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Dutch</TD> @@ -115,13 +115,13 @@ when the translator was updated. <TD>French</TD> <TD>Xavier Outhier</TD> <TD>xouthier@NOSPAM.yahoo.fr</TD> - <TD>up-to-date</TD> + <TD>strange</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>German</TD> <TD>Jens Seidel</TD> <TD>jensseidel@NOSPAM.users.sf.net</TD> - <TD>up-to-date</TD> + <TD>strange</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Greek</TD> @@ -139,19 +139,19 @@ when the translator was updated. <TD>Italian</TD> <TD>Alessandro Falappa<br>Ahmed Aldo Faisal</TD> <TD>alessandro@NOSPAM.falappa.net<br>aaf23@NOSPAM.cam.ac.uk</TD> - <TD>up-to-date</TD> + <TD>strange</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Japanese</TD> <TD>Ryunosuke Satoh<br>Kenji Nagamatsu</TD> <TD>sun594@NOSPAM.hotmail.com<br>naga@NOSPAM.joyful.club.ne.jp</TD> - <TD>up-to-date</TD> + <TD>strange</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Korean</TD> <TD>Richard Kim</TD> <TD>ryk@NOSPAM.dspwiz.com</TD> - <TD>up-to-date</TD> + <TD>strange</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Norwegian</TD> @@ -163,7 +163,7 @@ when the translator was updated. <TD>Polish</TD> <TD>Piotr Kaminski<br>Grzegorz Kowal</TD> <TD>Piotr.Kaminski@NOSPAM.ctm.gdynia.pl<br>g_kowal@NOSPAM.poczta.onet.pl</TD> - <TD>up-to-date</TD> + <TD>strange</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Portuguese</TD> @@ -181,7 +181,7 @@ when the translator was updated. <TD>Russian</TD> <TD>Alexandr Chelpanov</TD> <TD>cav@NOSPAM.cryptopro.ru</TD> - <TD>up-to-date</TD> + <TD>strange</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Serbian</TD> @@ -230,7 +230,7 @@ when the translator was updated. {\bf Language} & {\bf Maintainer} & {\bf Contact address} & {\bf Status} \\ \hline \hline - Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt chino@icmc.sc.usp.br} & up-to-date \\ + Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt chino@icmc.sc.usp.br} & strange \\ \hline Catalan & Albert Mora & {\tt amora@iua.upf.es} & 1.2.17 \\ \hline @@ -239,11 +239,11 @@ when the translator was updated. \hline Chinese Traditional & Gary Lee & {\tt garylee@ecosine.com.tw} & 1.2.16 \\ \hline - Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & up-to-date \\ + Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & strange \\ \hline - Czech & Petr P\v{r}ikryl & {\tt prikrylp@skil.cz} & up-to-date \\ + Czech & Petr P\v{r}ikryl & {\tt prikrylp@skil.cz} & strange \\ \hline - Danish & Erik S\o{}e S\o{}rensen & {\tt erik@mail.nu} & up-to-date \\ + Danish & Erik S\o{}e S\o{}rensen & {\tt erik@mail.nu} & strange \\ \hline Dutch & Dimitri van Heesch & {\tt dimitri@stack.nl} & up-to-date \\ \hline @@ -251,32 +251,32 @@ when the translator was updated. \hline Finnish & Olli Korhonen & {\tt Olli.Korhonen@ccc.fi} & obsolete \\ \hline - French & Xavier Outhier & {\tt xouthier@yahoo.fr} & up-to-date \\ + French & Xavier Outhier & {\tt xouthier@yahoo.fr} & strange \\ \hline - German & Jens Seidel & {\tt jensseidel@users.sf.net} & up-to-date \\ + German & Jens Seidel & {\tt jensseidel@users.sf.net} & strange \\ \hline Greek & Harry Kalogirou & {\tt harkal@rainbow.cs.unipi.gr} & 1.2.11 \\ \hline Hungarian & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt foldvari@diatronltd.com} & 1.2.1 \\ \hline - Italian & Alessandro Falappa & {\tt alessandro@falappa.net} & up-to-date \\ + Italian & Alessandro Falappa & {\tt alessandro@falappa.net} & strange \\ & Ahmed Aldo Faisal & {\tt aaf23@cam.ac.uk} & \\ \hline - Japanese & Ryunosuke Satoh & {\tt sun594@hotmail.com} & up-to-date \\ + Japanese & Ryunosuke Satoh & {\tt sun594@hotmail.com} & strange \\ & Kenji Nagamatsu & {\tt naga@joyful.club.ne.jp} & \\ \hline - Korean & Richard Kim & {\tt ryk@dspwiz.com} & up-to-date \\ + Korean & Richard Kim & {\tt ryk@dspwiz.com} & strange \\ \hline Norwegian & Lars Erik Jordet & {\tt lej@circuitry.no} & 1.2.2 \\ \hline - Polish & Piotr Kaminski & {\tt Piotr.Kaminski@ctm.gdynia.pl} & up-to-date \\ + Polish & Piotr Kaminski & {\tt Piotr.Kaminski@ctm.gdynia.pl} & strange \\ & Grzegorz Kowal & {\tt g\_kowal@poczta.onet.pl} & \\ \hline Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & 1.2.18 \\ \hline Romanian & Alexandru Iosup & {\tt aiosup@yahoo.com} & 1.2.16 \\ \hline - Russian & Alexandr Chelpanov & {\tt cav@cryptopro.ru} & up-to-date \\ + Russian & Alexandr Chelpanov & {\tt cav@cryptopro.ru} & strange \\ \hline Serbian & Dejan Milosavljevic & {\tt dmilos@email.com} & 1.2.17 \\ \hline |