summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPetr Prikryl <prikryl@atlas.cz>2013-09-02 10:47:40 (GMT)
committerPetr Prikryl <prikryl@atlas.cz>2013-09-02 10:47:40 (GMT)
commit22c670cbeb648805428f79585999f4b7170335c9 (patch)
treee066b73467e78933d1c470f2397e4929873ef39e
parent40c6440241f2b28fc9096d8e41d95e7e76af798f (diff)
downloadDoxygen-22c670cbeb648805428f79585999f4b7170335c9.zip
Doxygen-22c670cbeb648805428f79585999f4b7170335c9.tar.gz
Doxygen-22c670cbeb648805428f79585999f4b7170335c9.tar.bz2
doc/language.tpl -- trailing spaces removed
-rw-r--r--doc/language.tpl72
1 files changed, 36 insertions, 36 deletions
diff --git a/doc/language.tpl b/doc/language.tpl
index 80b81da..005d51f 100644
--- a/doc/language.tpl
+++ b/doc/language.tpl
@@ -3,13 +3,13 @@ ATTENTION! This is the template for generating language.doc. If you want to
change the language.doc, make the changes here and inside maintainers.txt.
/******************************************************************************
- * %(editnote)s
+ * %(editnote)s
*
* Copyright (C) 1997-2013 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
- * documentation under the terms of the GNU General Public License is hereby
- * granted. No representations are made about the suitability of this software
+ * documentation under the terms of the GNU General Public License is hereby
+ * granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
@@ -26,7 +26,7 @@ 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 %(doxVersion)s), %(numLangStr)s languages
+Currently (version %(doxVersion)s), %(numLangStr)s languages
are supported (sorted alphabetically):
%(supportedLangReadableStr)s.
@@ -38,10 +38,10 @@ when the translator was updated.
%(informationTable)s
Most people on the list have indicated that they were also busy
-doing other things, so if you want to help to speed things up please
+doing other things, so if you want to help to speed things up please
let them (or me) know.
-If you want to add support for a language that is not yet listed
+If you want to add support for a language that is not yet listed
please read the next section.
@@ -52,12 +52,12 @@ This short HOWTO explains how to add support for the new language to Doxygen:
Just follow these steps:
<ol>
<li>Tell me for which language you want to add support. If no one else
- is already working on support for that language, you will be
- assigned as the maintainer for the language.
-<li>Create a copy of translator_en.h and name it
+ is already working on support for that language, you will be
+ assigned as the maintainer for the language.
+<li>Create a copy of translator_en.h and name it
translator_\<your_2_letter_country_code\>.h
I'll use xx in the rest of this document.
-<li>Add definition of the symbol for your language in the configure
+<li>Add definition of the symbol for your language in the configure
at two places in the script:
<ol>
<li>After the <code>f_langs=</code> is statement, in lower case.
@@ -66,7 +66,7 @@ at two places in the script:
The rerun the configure script such that is generates src/lang_cfg.h.
This file should now contain a \#define for your language code.
<li>Edit language.cpp:
- Add a
+ Add a
\verbatim
#ifdef LANG_xx
#include<translator_xx.h>
@@ -83,31 +83,31 @@ This file should now contain a \#define for your language code.
{
theTranslator = new TranslatorYourLanguage;
}
-#endif
+#endif
\endverbatim
after the <code>if { ... }</code>. I.e., it must be placed after the code
- for creating the English translator at the beginning, and before the
- <code>else { ... }</code> part that creates the translator for the
+ for creating the English translator at the beginning, and before the
+ <code>else { ... }</code> part that creates the translator for the
default language (English again).
-<li>Edit libdoxygen.pro.in and add \c translator_xx.h to
+<li>Edit libdoxygen.pro.in and add \c translator_xx.h to
the \c HEADERS line.
<li>Edit <code>translator_xx.h</code>:
<ul>
- <li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code>
- twice (i.e. in the \c \#ifndef and \c \#define preprocessor commands at
+ <li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code>
+ twice (i.e. in the \c \#ifndef and \c \#define preprocessor commands at
the beginning of the file).
- <li>Rename TranslatorEnglish to TranslatorYourLanguage
- <li>In the member <code>idLanguage()</code> change "english" into the
+ <li>Rename TranslatorEnglish to TranslatorYourLanguage
+ <li>In the member <code>idLanguage()</code> change "english" into the
name of your language (use lower case characters only). Depending
- on the language you may also wish to change the member functions
+ on the language you may also wish to change the member functions
latexLanguageSupportCommand(), idLanguageCharset() and others
(you will recognize them when you start the work).
- <li>Edit all the strings that are returned by the member functions that
- start with tr.
+ <li>Edit all the strings that are returned by the member functions that
+ start with tr.
Try to match punctuation and capitals!
To enter special characters (with accents) you can:
<ul>
- <li> Enter them directly if your keyboard supports that and you are
+ <li> Enter them directly if your keyboard supports that and you are
using a Latin-1 font. Doxygen will translate the
characters to proper \f$\mbox{\LaTeX}\f$ and leave the
HTML and man output for what it is (which is fine, if
@@ -116,9 +116,9 @@ This file should now contain a \#define for your language code.
See the HTML specification for the codes.
</ul>
</ul>
-<li>Run configure and make again from the root of the distribution,
+<li>Run configure and make again from the root of the distribution,
in order to regenerated the Makefiles.
-<li>Now you can use <code>OUTPUT_LANGUAGE = your_language_name</code>
+<li>Now you can use <code>OUTPUT_LANGUAGE = your_language_name</code>
in the config file to generate output in your language.
<li>Send <code>translator_xx.h</code> to me so I can add it to doxygen.
Send also your name and e-mail address to be included in the
@@ -138,7 +138,7 @@ until all language maintainers have translated the new sentences and
sent the results would not be very practical. The following text
describes the usage of translator adapters to solve the problem.
-<b>The role of Translator Adapters.</b>
+<b>The role of Translator Adapters.</b>
Whenever the \c Translator class interface changes in the new
release, the new class \c TranslatorAdapter_x_y_z is added to the \c
translator_adapter.h file (here x, y, and z are numbers that
@@ -154,7 +154,7 @@ TranslatorAdapter_x_y_z class may use the obsolete method to get the
result which is as close as possible to the older result in the
target language. If it is not possible, the result (the default
translation) is obtained using the English translator, which is (by
-definition) always up-to-date.
+definition) always up-to-date.
<b>For example,</b> when the new \c trFile() method with
parameters (to determine the capitalization of the first letter and
@@ -184,7 +184,7 @@ of the translator adapter classes:
The \c trFiles() is not present in the \c TranslatorEnglish class,
because it was removed as obsolete. However, it was used until now
-and its call was replaced by
+and its call was replaced by
\verbatim
trFile(true, false)
@@ -250,15 +250,15 @@ translator adapter classes.
<b>To simplify the maintenance of the language translator classes</b>
for the supported languages, the \c translator.py Python
-script was developed (located in \c doxygen/doc directory).
+script was developed (located in \c doxygen/doc directory).
It extracts the important information about obsolete and
-new methods from the source files for each of the languages.
+new methods from the source files for each of the languages.
The information is stored in the translator report ASCII file
-(\c %(translatorReportFileName)s).
+(\c %(translatorReportFileName)s).
\htmlonly If you compiled this documentation
from sources and if you have also doxygen sources available the
-link %(translatorReportLink)s should be valid.\endhtmlonly
+link %(translatorReportLink)s should be valid.\endhtmlonly
Looking at the base class of the language translator, the script
guesses also the status of the translator -- see the last column of
@@ -281,7 +281,7 @@ expected, you can always decide use some suitable translator adapter to
finish the changes later and still make your translator working.
<b>The most radical way of updating the language translator</b> is
-to make your translator class derive directly
+to make your translator class derive directly
from the abstract class \c Translator and provide translations for the
methods that are required to be implemented -- the compiler will
tell you if you forgot to implement some of them. If you are in
@@ -294,7 +294,7 @@ because the adapter classes do implement also the obsolete methods
In other words, the up-to-date language translators do not need the
\c TranslatorAdapter_x_y_z classes at all, and you do not need to
implement anything else than the methods required by the Translator
-class (i.e. the pure virtual methods of the \c Translator -- they
+class (i.e. the pure virtual methods of the \c Translator -- they
end with <code>=0;</code>).
If everything compiles fine, try to run \c translator.py, and have a
@@ -329,7 +329,7 @@ report shorter (also produced faster) -- it will contain only the
information related to your translator. Once you reach the state when
the base class should be changed to some newer adapter, you will see
the note in the translator report.
-
+
Warning: Don't forget to compile Doxygen to discover, whether it is
compilable. The \c translator.py does not check if everything is
correct with respect to the compiler. Because of that, it may lie
@@ -344,7 +344,7 @@ When doing so, all the missing methods will be replaced by the
English translation. This means that not-implemented methods will
always return the English result. Such translators are marked using
word \c obsolete. You should read it <b>really obsolete</b>. No
-guess about the last update can be done.
+guess about the last update can be done.
Often, it is possible to construct better result from the obsolete
methods. Because of that, the translator adapter classes should be