diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 11 | ||||
| -rw-r--r-- | doc/config.doc | 16 | ||||
| -rw-r--r-- | doc/faq.doc | 4 | ||||
| -rw-r--r-- | doc/language.doc | 61 | ||||
| -rw-r--r-- | doc/translator.py | 81 |
5 files changed, 119 insertions, 54 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 932f83f..652f2ce 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -440,11 +440,11 @@ doxygen. Unrecognized commands are treated as normal text. \verbatim /*! \mainpage My Personal Index Page * - * \section intro Introduction + * \section intro_sec Introduction * * This is the introduction. * - * \section install Installation + * \section install_sec Installation * * \subsection step1 Step 1: Opening the box * @@ -603,13 +603,6 @@ See section \ref memgroup for an example. non-friend functions that are nevertheless strongly coupled to a certain class. It only works for functions. - \par Example: - \verbinclude relates.cpp - \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/relates/html/globals.html">here</a> - for the corresponding HTML documentation that is generated by doxygen. - \endhtmlonly - <hr> \section cmdshowinitializer \showinitializer diff --git a/doc/config.doc b/doc/config.doc index a465086..f71e636 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -359,14 +359,6 @@ followed by the descriptions of the tags grouped by category. (but less readable) file names. This can be useful is your file systems doesn't support long names like on DOS, Mac, or CD-ROM. -\anchor cfg_verbatim_headers -<dt>\c VERBATIM_HEADERS <dd> - \addindex VERBATIM_HEADERS - If the \c VERBATIM_HEADERS tag is set the \c YES (the default) then doxygen - will generate a verbatim copy of the header file for each class for - which an include is specified. Set to NO to disable this. - \sa Section \ref cmdclass "\\class". - \anchor cfg_javadoc_autobrief <dt>\c JAVADOC_AUTOBRIEF <dd> \addindex JAVADOC_AUTOBRIEF @@ -830,6 +822,14 @@ function's detailed documentation block. then for each documented function all documented entities called/used by that function will be listed. +\anchor cfg_verbatim_headers +<dt>\c VERBATIM_HEADERS <dd> + \addindex VERBATIM_HEADERS + If the \c VERBATIM_HEADERS tag is set the \c YES (the default) then doxygen + will generate a verbatim copy of the header file for each class for + which an include is specified. Set to NO to disable this. + \sa Section \ref cmdclass "\\class". + </dl> \section alphabetical_index Alphabetical index options diff --git a/doc/faq.doc b/doc/faq.doc index 646d43a..af779ae 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -23,11 +23,11 @@ You should use the \\mainpage command inside a comment block like this: \verbatim /*! \mainpage My Personal Index Page * - * \section intro Introduction + * \section intro_sec Introduction * * This is the introduction. * - * \section install Installation + * \section install_sec Installation * * \subsection step1 Step 1: Opening the box * diff --git a/doc/language.doc b/doc/language.doc index 595a75c..0f94ac5 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -23,13 +23,12 @@ text fragments, generated by doxygen, can be produced in languages other than English (the default). The output language is chosen through the configuration file (with default name and known as Doxyfile). -Currently (version 1.3.7), 29 languages +Currently (version 1.3.7-20040616), 29 languages are supported (sorted alphabetically): Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, French, German, Greek, Hungarian, Italian, Japanese (+En), Korean (+En), Lithuanian, -Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, -Slovene, Spanish, Swedish, and Ukrainian.. +Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak,. The table of information related to the supported languages follows. It is sorted by language alphabetically. The <b>Status</b> column @@ -54,7 +53,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>1.3.8</td> </tr> <tr bgcolor="#ffffff"> <td>Catalan</td> @@ -72,31 +71,31 @@ when the translator was updated. <td>Chinese Traditional</td> <td>Daniel YC Lin<br>Gary Lee</td> <td>daniel@NOSPAM.twpda.com<br>garylee@NOSPAM.ecosine.com.tw</td> - <td>up-to-date</td> + <td>1.3.8</td> </tr> <tr bgcolor="#ffffff"> <td>Croatian</td> <td>Boris Bralo</td> <td>boris.bralo@NOSPAM.zg.tel.hr</td> - <td>up-to-date</td> + <td>1.3.8</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>1.3.8</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>1.3.8</td> </tr> <tr bgcolor="#ffffff"> <td>Dutch</td> <td>Dimitri van Heesch</td> <td>dimitri@NOSPAM.stack.nl</td> - <td>up-to-date</td> + <td>1.3.8</td> </tr> <tr bgcolor="#ffffff"> <td>English</td> @@ -114,13 +113,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>1.3.8</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>1.3.8</td> </tr> <tr bgcolor="#ffffff"> <td>Greek</td> @@ -132,13 +131,13 @@ when the translator was updated. <td>Hungarian</td> <td>Földvári György<br>Ákos Kiss</td> <td>foldvari@NOSPAM.diatronltd.com<br>akiss@NOSPAM.users.sourceforge.net</td> - <td>up-to-date</td> + <td>1.3.8</td> </tr> <tr bgcolor="#ffffff"> <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>1.3.8</td> </tr> <tr bgcolor="#ffffff"> <td>Japanese</td> @@ -156,7 +155,7 @@ when the translator was updated. <td>Korean</td> <td>Richard Kim</td> <td>ryk@NOSPAM.dspwiz.com</td> - <td>up-to-date</td> + <td>1.3.8</td> </tr> <tr bgcolor="#ffffff"> <td>KoreanEn</td> @@ -168,7 +167,7 @@ when the translator was updated. <td>Lithuanian</td> <td>Tomas Simonaitis<br>Mindaugas Radzius<br>Aidas Berukstis</td> <td>haden@NOSPAM.homelan.lt<br>mindaugasradzius@NOSPAM.takas.lt<br>aidasber@NOSPAM.takas.lt</td> - <td>up-to-date</td> + <td>1.3.8</td> </tr> <tr bgcolor="#ffffff"> <td>Norwegian</td> @@ -204,7 +203,7 @@ when the translator was updated. <td>Serbian</td> <td>Dejan Milosavljevic</td> <td>dmilos@NOSPAM.email.com</td> - <td>up-to-date</td> + <td>1.3.8</td> </tr> <tr bgcolor="#ffffff"> <td>Slovak</td> @@ -222,7 +221,7 @@ when the translator was updated. <td>Spanish</td> <td>Francisco Oltra Thennet</td> <td>foltra@NOSPAM.puc.cl</td> - <td>up-to-date</td> + <td>1.3.08</td> </tr> <tr bgcolor="#ffffff"> <td>Swedish</td> @@ -251,38 +250,38 @@ when the translator was updated. \hline \hline - Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt\tiny chino@icmc.sc.usp.br} & up-to-date \\ + Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt\tiny chino@icmc.sc.usp.br} & 1.3.8 \\ \hline Catalan & Albert Mora & {\tt\tiny amora@iua.upf.es} & 1.2.17 \\ \hline Chinese & Wei Liu & {\tt\tiny liuwei@asiainfo.com} & 1.2.13 \\ ~ & Wang Weihan & {\tt\tiny wangweihan@capinfo.com.cn} & ~ \\ \hline - Chinese Traditional & Daniel YC Lin & {\tt\tiny daniel@twpda.com} & up-to-date \\ + Chinese Traditional & Daniel YC Lin & {\tt\tiny daniel@twpda.com} & 1.3.8 \\ ~ & Gary Lee & {\tt\tiny garylee@ecosine.com.tw} & ~ \\ \hline - Croatian & Boris Bralo & {\tt\tiny boris.bralo@zg.tel.hr} & up-to-date \\ + Croatian & Boris Bralo & {\tt\tiny boris.bralo@zg.tel.hr} & 1.3.8 \\ \hline - Czech & Petr P\v{r}ikryl & {\tt\tiny prikrylp@skil.cz} & up-to-date \\ + Czech & Petr P\v{r}ikryl & {\tt\tiny prikrylp@skil.cz} & 1.3.8 \\ \hline - Danish & Erik S\o{}e S\o{}rensen & {\tt\tiny erik@mail.nu} & up-to-date \\ + Danish & Erik S\o{}e S\o{}rensen & {\tt\tiny erik@mail.nu} & 1.3.8 \\ \hline - Dutch & Dimitri van Heesch & {\tt\tiny dimitri@stack.nl} & up-to-date \\ + Dutch & Dimitri van Heesch & {\tt\tiny dimitri@stack.nl} & 1.3.8 \\ \hline English & Dimitri van Heesch & {\tt\tiny dimitri@stack.nl} & up-to-date \\ \hline Finnish & Olli Korhonen & {\tt\tiny Olli.Korhonen@ccc.fi} & obsolete \\ \hline - French & Xavier Outhier & {\tt\tiny xouthier@yahoo.fr} & up-to-date \\ + French & Xavier Outhier & {\tt\tiny xouthier@yahoo.fr} & 1.3.8 \\ \hline - German & Jens Seidel & {\tt\tiny jensseidel@users.sf.net} & up-to-date \\ + German & Jens Seidel & {\tt\tiny jensseidel@users.sf.net} & 1.3.8 \\ \hline Greek & Harry Kalogirou & {\tt\tiny harkal@rainbow.cs.unipi.gr} & 1.2.11 \\ \hline - Hungarian & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt\tiny foldvari@diatronltd.com} & up-to-date \\ + Hungarian & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt\tiny foldvari@diatronltd.com} & 1.3.8 \\ ~ & \'{A}kos Kiss & {\tt\tiny akiss@users.sourceforge.net} & ~ \\ \hline - Italian & Alessandro Falappa & {\tt\tiny alessandro@falappa.net} & up-to-date \\ + Italian & Alessandro Falappa & {\tt\tiny alessandro@falappa.net} & 1.3.8 \\ ~ & Ahmed Aldo Faisal & {\tt\tiny aaf23@cam.ac.uk} & ~ \\ \hline Japanese & Ryunosuke Satoh & {\tt\tiny sun594@hotmail.com} & 1.3.3 \\ @@ -290,11 +289,11 @@ when the translator was updated. \hline JapaneseEn & see the Japanese language & {\tt\tiny ~} & English based \\ \hline - Korean & Richard Kim & {\tt\tiny ryk@dspwiz.com} & up-to-date \\ + Korean & Richard Kim & {\tt\tiny ryk@dspwiz.com} & 1.3.8 \\ \hline KoreanEn & see the Korean language & {\tt\tiny ~} & English based \\ \hline - Lithuanian & Tomas Simonaitis & {\tt\tiny haden@homelan.lt} & up-to-date \\ + Lithuanian & Tomas Simonaitis & {\tt\tiny haden@homelan.lt} & 1.3.8 \\ ~ & Mindaugas Radzius & {\tt\tiny mindaugasradzius@takas.lt} & ~ \\ ~ & Aidas Berukstis & {\tt\tiny aidasber@takas.lt} & ~ \\ \hline @@ -309,13 +308,13 @@ when the translator was updated. \hline Russian & Alexandr Chelpanov & {\tt\tiny cav@cryptopro.ru} & up-to-date \\ \hline - Serbian & Dejan Milosavljevic & {\tt\tiny dmilos@email.com} & up-to-date \\ + Serbian & Dejan Milosavljevic & {\tt\tiny dmilos@email.com} & 1.3.8 \\ \hline Slovak & Stanislav Kudl\'{a}\v{c} & {\tt\tiny skudlac@pobox.sk} & 1.2.18 \\ \hline Slovene & Matjaz Ostroversnik & {\tt\tiny matjaz.ostroversnik@zrs-tk.si} & 1.2.16 \\ \hline - Spanish & Francisco Oltra Thennet & {\tt\tiny foltra@puc.cl} & up-to-date \\ + Spanish & Francisco Oltra Thennet & {\tt\tiny foltra@puc.cl} & 1.3.08 \\ \hline Swedish & Mikael Hallin & {\tt\tiny mikaelhallin@yahoo.se} & 1.3.3 \\ \hline diff --git a/doc/translator.py b/doc/translator.py index 8a8b99f..c3527a8 100644 --- a/doc/translator.py +++ b/doc/translator.py @@ -40,17 +40,90 @@ content should be more useful for developers. 2004/02/11 - Some tuning-up to provide more useful information. 2004/04/16 - Added new tokens to the tokenizer (to remove some warnings). + 2004/05/25 - Added from __future__ import generators not to force Python 2.3. + 2004/06/03 - Removed dependency on textwrap module. """ -import os, re, sys, textwrap +from __future__ import generators +import os, re, sys def fill(s): """Returns string formated to the wrapped paragraph multiline string. Replaces whitespaces by one space and then uses he textwrap.fill().""" + + # Replace all whitespace by spaces, remove whitespaces that are not + # necessary, strip the left and right whitespaces, and break the string + # to list of words. rexWS = re.compile(r'\s+') - return textwrap.fill(rexWS.sub(' ', s)) + lst = rexWS.sub(' ', s).strip().split() + + # If the list is not empty, put the words together and form the lines + # of maximum 70 characters. Build the list of lines. + lines = [] + if lst: + line = lst.pop(0) # no separation space in front of the first word + for word in lst: + if len(line) + len(word) < 70: + line += ' ' + word + else: + lines.append(line) # another full line formed + line = word # next line started + + return '\n'.join(lines) + + +# The following function dedent() is the verbatim copy from the textwrap.py +# module. The textwrap.py was introduced in Python 2.3. To make this script +# working also in older Python versions, I have decided to copy it. +# Notice that the textwrap.py is copyrighted: +# +# Copyright (C) 1999-2001 Gregory P. Ward. +# Copyright (C) 2002, 2003 Python Software Foundation. +# Written by Greg Ward <gward@python.net> +# +# The explicit permission to use the code here was sent by Guido van Rossum +# (4th June, 2004). +# +def dedent(text): + """dedent(text : string) -> string + + Remove any whitespace than can be uniformly removed from the left + of every line in `text`. + + This can be used e.g. to make triple-quoted strings line up with + the left edge of screen/whatever, while still presenting it in the + source code in indented form. + + For example: + + def test(): + # end first line with \ to avoid the empty line! + s = '''\ + hello + world + ''' + print repr(s) # prints ' hello\n world\n ' + print repr(dedent(s)) # prints 'hello\n world\n' + """ + lines = text.expandtabs().split('\n') + margin = None + for line in lines: + content = line.lstrip() + if not content: + continue + indent = len(line) - len(content) + if margin is None: + margin = indent + else: + margin = min(margin, indent) + + if margin is not None and margin > 0: + for i in range(len(lines)): + lines[i] = lines[i][margin:] + + return '\n'.join(lines) class Transl: @@ -1521,7 +1594,7 @@ class TrManager: </table> \\endhtmlonly ''' - htmlTableTpl = textwrap.dedent(htmlTableTpl) + htmlTableTpl = dedent(htmlTableTpl) htmlTrTpl = '\n <tr bgcolor="#ffffff">%s\n </tr>' htmlTdTpl = '\n <td>%s</td>' @@ -1585,7 +1658,7 @@ class TrManager: \end{tabular} \endlatexonly ''' - latexTableTpl = textwrap.dedent(latexTableTpl) + latexTableTpl = dedent(latexTableTpl) latexLineTpl = '\n' + r' %s & %s & {\tt\tiny %s} & %s \\' # Loop through transl objects in the order of sorted readable names |