summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2013-10-01 17:14:28 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2013-10-06 11:50:46 (GMT)
commitac2cd570cc7f606963d7cac15d3f3e11c6e305f3 (patch)
tree1a29528b7b89f2c2e1841d0957a2da1d376cda65 /doc
parente835d4b28e1db3bdcdf3bfa718bc85445587ccd9 (diff)
downloadDoxygen-ac2cd570cc7f606963d7cac15d3f3e11c6e305f3.zip
Doxygen-ac2cd570cc7f606963d7cac15d3f3e11c6e305f3.tar.gz
Doxygen-ac2cd570cc7f606963d7cac15d3f3e11c6e305f3.tar.bz2
This patch contains changes regarding the build system so that the *nix and Windows systems use the same information (consistency). Some use names routine names have been changed (from .l files with -P option) to reflect the file name that generated the routines, this makes it easier to create a general procedure.
A number of include / header files are files are generated from different file types (html, xml, js), due some limitations of the windows build system the generated file names had to be changed (the extension in the windows build system is only available including the '.' so e.g. the file jquery_fx.js generates now jquery_fx.js.h instead of jquery_fx_js.h) In the windows version the creation of .cpp files from .l files has been adjusted to correct for the YY_BUF_SIZE problems. Furthermore on windows (and also used on *nix) some commends have been replaced with python scripts so that on windows only python is need (besides flex and and bison). On *nix also perl is required for the generation using tmake. Below a short description of the changes will be given and grouped. Changed files ============= - .gitignore added some directories and file - Doxyfile corrected for changed file names - Makefile.in added realclean and some other changes (ignore error) and the moment when the Makefile is deleted (as last file). Added entries for doxyapp and doxmlparser Added realclean for the following files (consistency): ====================================================== - Makefile.win_make.in - Makefile.win_nmake.in - addon/doxmlparser/examples/metrics/Makefile.in - addon/doxmlparser/src/Makefile.in - addon/doxmlparser/test/Makefile.in - addon/doxyapp/Makefile.in - addon/doxysearch/Makefile.in - libmd5/Makefile.in - qtools/Makefile.in - addon/doxyapp/doxyapp.pro.in removed double occurence of -L../../lib - addon/doxysearch/doxysearch.pro.in no visible change just spacing? - addon/doxywizard/Makefile.in added realclean corrected call to qmake (to get it from the right place, it is not necessarily in the path) made some macros known in the called process - addon/doxywizard/configdoc.cpp automatically generated, can be removed - addon/doxywizard/doxywizard.pro.in corrected dependencies corrected call to python (to get it from the right place, it is not necessarily in the path) new items to generate version.cpp and config_doxyw.cpp - configure added configuration definition possibility for python added possibility to build doxmlparser automatically generate the lang_cfg.h file based on the available languages (translator_??.h) and not on a fixed list. This step still has to be added to the windows build process. - doc/Makefile.in corrected call to python (to get it from the right place, it is not necessarily in the path) - doc/config.doc small correction - doc/install.doc added python as a requirement changed CVS to GitHub - doc/language.doc automatically generated file, based on other changes. - doc/language.tpl made XX and xx more consistent changed description of the procedure based on changes already made configure. - src/Makefile.in adjusted used file names in distclean Solved PERL usage consistent with LEX / YACC (with %%PERL%%) automatically add translator_??>h to HEADERS same spacing Adjusted in the following file the names of some include files: =============================================================== - src/cite.cpp - src/docbookgen.cpp - src/ftvhelp.cpp - src/htmlgen.cpp - src/layout.cpp - src/searchindex.cpp - src/xmlgen.cpp Adjusted in the following files some routine names (..YY..) to be consistent with the file names: ================================================================================================= - src/commentscan.l - src/constexp.h - src/constexp.l - src/constexp.y - src/fortrancode.l - src/fortranscanner.l - src/pyscanner.l - src/pre.l - src/scanner.l - src/tclscanner.l - src/vhdlparser.y - src/vhdlscanner.l - src/config.xml small textual correction - src/configoptions.cpp generated output file, can be removed - src/lang_cfg.h Automatically generated file with selected languages (*nix). On windows a procedure has to be defined. - src/libdoxycfg.t.in corrected call to python (to get it from the right place, it is not necessarily in the path) - src/libdoxygen.pro.in adjusted include file names removed translator_??.h files, they are added automatically changed file name ce_lex.cpp -> constexp.cpp (generated file) - src/libdoxygen.t.in made LEX calls used the file name for the -P option changed INCREASEBUF script to a python script changed teh geneartion of some include file, now by means of a pythons script. Names of the generated include file had to be changed as well. added possibility to generate version.cpp here as well. Added HEADERS to dependency so non existing but later generated include files are recognized as well: ===================================================================================================== - tmake/lib/unix/generic.t - tmake/lib/win32-borland/generic.t - tmake/lib/win32-g++/generic.t - tmake/lib/win32-mingw/generic.t - tmake/lib/win32-msvc/generic.t - tmake/lib/win32-symantec/generic.t - tmake/lib/win32-visage/generic.t - tmake/lib/win32-watcom/generic.t - winbuild/Doxygen.vcproj made consistent wit *nix version. Generating all possible files removed unused /empty parts setting for the Lex.rules and other rules files some default values - winbuild/Doxywizard.vcproj made consistent wit *nix version. Generating all possible files removed unused /empty parts removed system dependent paths (C:\... etc) replaced then with external environment variables - winbuild/Lex.rules adjusted file to comply with new requirements, only user variable is -d. -i is set to read only (value can be changed in doxygen.vcproj). Handling of other arguments is all default. generation including increasebuffer possibility - winbuild/doxyindexer.vcproj corrected path - winbuild/doxysearch.vcproj removed system dependent paths (C:\... etc) replaced then with external environment variables - winbuild/qtools.vcproj corrected type, wrong used directory The following files are automatically generated (with slightly other names like index.xsd.h etc.): ================================================================================================== - src/index_xsd.h - src/doxygen_bst.h - src/dynsections_js.h - src/extsearch_js.h - src/footer_html.h - src/header_html.h - src/jquery_fx_js.h - src/jquery_p1_js.h - src/jquery_p2_js.h - src/jquery_p3_js.h - src/jquery_pt_js.h - src/jquery_ui_js.h - src/navtree_css.h - src/navtree_js.h - src/resize_js.h - src/search_css.h - src/search_functions_php.h - src/search_js.h - src/search_opensearch_php.h - src/svgpan_js.h the following files are generated with different names: - src/bib2xhtml.h becomes - src/bib2xhtml.pl/h - src/layout_default.h becomes - src/layout_default.xml.h The file: ========= - addon/doxywizard/config.l is replaced by: - addon/doxywizard/config_doxyw.l so there are in the system not 2 different config.l files. Renamed some routines from configYY -> config_doxywYY... New files: ========== - src/increasebuffer.py increase YY_BUF_SIZE and YY_READ_BUF_SIZE from 16k / 8k to 256k. - src/settings.py create settings.h file - src/to_c_cmd.py create include files from different files (html, xml, js) so they can be included in the code as defaults - src/version.py create version.cpp file based on the configure file - winbuild/Config.rules rules file to convert the config.xml file into configoptions.cpp (doxygen) or configdoc.cpp (doxywizard). Seen the differences 2 rules are created within this file. - winbuild/Gen_head.rules rules files to generate include files from different files using to_c_cmd.py - winbuild/Settings.rules rules file for generating the settings.h file. It is possible to select to use CLANG and SqlLite3 - winbuild/Version.rules rules file to be able to start version.py The files: ========== - version.bat - runbison.bat - increasebuffer.pl are not used anymore. I've only added the files as indicated, I didn't remove the files from the repository.
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.in4
-rw-r--r--doc/config.doc2
-rw-r--r--doc/install.doc6
-rw-r--r--doc/language.doc35
-rw-r--r--doc/language.tpl31
5 files changed, 28 insertions, 50 deletions
diff --git a/doc/Makefile.in b/doc/Makefile.in
index cf1e461..5036116 100644
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -31,9 +31,9 @@ clean:
language: language.doc
language.doc: $(wildcard ../src/translator*.h) maintainers.txt language.tpl translator.py
- python translator.py
+ $(PYTHON) translator.py
config.doc: ../src/config.xml ../src/configgen.py
- python ../src/configgen.py -doc ../src/config.xml > config.doc
+ $(PYTHON) ../src/configgen.py -doc ../src/config.xml > config.doc
FORCE:
diff --git a/doc/config.doc b/doc/config.doc
index de563ad..ec19732 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -1056,7 +1056,7 @@ The default value is: <code>YES</code>.
If the \c SORT_BRIEF_DOCS tag is set to \c YES then doxygen will sort the
brief descriptions of file, namespace and class members alphabetically
by member name. If set to \c NO the members will appear in
- declaration order. Note the this will also influence the order of the
+ declaration order. Note that this will also influence the order of the
classes in the class list.
diff --git a/doc/install.doc b/doc/install.doc
index a4fe2f7..2f4373d 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -269,10 +269,10 @@ compile doxygen. Alternatively, you can compile doxygen
<a href="http://en.wikipedia.org/wiki/Cygwin">Cygwin</a>
or <a href="http://www.mingw.org/">MinGW</a>.
-The next step is to install \c bison, \c flex, and \c tar
-(see http://gnuwin32.sourceforge.net/packages.html).
+The next step is to install \c bison, \c flex, \c tar
+(see http://gnuwin32.sourceforge.net/packages.html) and \c python (version 2, see http://www.python.org).
This packages are needed during the
-compilation process if you use a CVS snapshot of doxygen (the official source releases
+compilation process if you use a GitHub snapshot of doxygen (the official source releases
come with pre-generated sources).
Download doxygen's source tarball and put it somewhere (e.g. use <code>c:\\tools</code>)
diff --git a/doc/language.doc b/doc/language.doc
index c9e0945..585b0df 100644
--- a/doc/language.doc
+++ b/doc/language.doc
@@ -201,7 +201,7 @@ when the translator was updated.
<td bgcolor="#ffffff">Latvian</td>
<td>Lauris</td>
<td>lauris at nix.lv</td>
- <td bgcolor="#ccffcc">up-to-date</td>
+ <td bgcolor="#ffffcc">1.8.4</td>
</tr>
<tr bgcolor="#ffffff">
<td bgcolor="#ff5555">Lithuanian</td>
@@ -386,7 +386,7 @@ when the translator was updated.
\hline
KoreanEn & see the Korean language & {\tt\tiny ~} & English based \\
\hline
- Latvian & Lauris & {\tt\tiny lauris at nix.lv} & up-to-date \\
+ Latvian & Lauris & {\tt\tiny lauris at nix.lv} & 1.8.4 \\
\hline
Lithuanian & Tomas Simonaitis & {\tt\tiny [unreachable] haden at homelan dot lt} & 1.4.6 \\
~ & Mindaugas Radzius & {\tt\tiny [unreachable] mindaugasradzius at takas dot lt} & ~ \\
@@ -456,31 +456,22 @@ Just follow the following steps:
<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
- `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`
-script at two places in the script:
- <ol>
- <li>After the <code>f_langs=</code> is statement, in lower case.
- <li>In the string that following <code>\@allowed=</code> in upper case.
- </ol>
-The rerun the `configure` script such that is generates `doxygen/src/lang_cfg.h`.
+<li>Create a copy of `doxygen/src/translator_en.h` and name it
+ `doxygen/src/translator_\<your_2_letter_country_code\>.h`
+ I'll use `xx` in the rest of this document (add `XX` for the uppercase version).
+<li> Rerun the `configure` script such that it generates `doxygen/src/lang_cfg.h`.
This file should now contain a \c \#define for your language code.
<li>Edit `doxygen/src/language.cpp`:
Add the following code:
\verbatim
-#ifdef LANG_xx
+#ifdef LANG_XX
#include<translator_xx.h>
#endif
\endverbatim
- Remember to use the same symbol `LANG_xx` that you added to \c lang_cfg.h.
- I.e., the \c xx should be capital letters that identify your language.
- On the other hand, the \c xx inside your \c translator_xx.h should use
- lower case.
+ Remember to use the same symbol `LANG_XX` that was added to `doxygen/src/lang_cfg.h`.
<p>Now, in <code>setTranslator()</code> add
\verbatim
-#ifdef LANG_xx
+#ifdef LANG_XX
else if (L_EQUAL("your_language_name"))
{
theTranslator = new TranslatorYourLanguage;
@@ -491,9 +482,7 @@ This file should now contain a \c \#define for your language code.
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 `doxygen/src/libdoxygen.pro.in` and add \c translator_xx.h to
- the \c HEADERS line.
-<li>Edit <code>translator_xx.h</code>:
+<li>Edit <code>doxygen/src/translator_xx.h</code>:
<ul>
<li>Use the UTF-8 capable editor and open the file using the UTF-8 mode.
<li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code>
@@ -514,12 +503,12 @@ This file should now contain a \c \#define for your language code.
the text is expected to be saved using the UTF-8 encoding. Doxygen
will translate the characters to proper \f$\mbox{\LaTeX}\f$ and
leaves the HTML and man output in UTF-8.
- <li> Use HTML codes like \&auml; for an \c a with an \c umlaut (i.e. &auml;).
+ <li> Use HTML codes like `\&auml;` for an \c a with an \c umlaut (i.e. &auml;).
See the HTML specification for the codes.
</ul>
</ul>
<li>Run \c configure and \c make again from the root (i.e. in the \c doxygen
- directory) of the distribution, in order to regenerate the \c Makefiles.
+ directory) of the distribution, in order to regenerate the `Makefile`s.
<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.
diff --git a/doc/language.tpl b/doc/language.tpl
index f4b7b41..966e669 100644
--- a/doc/language.tpl
+++ b/doc/language.tpl
@@ -55,31 +55,22 @@ Just follow the following steps:
<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
- `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`
-script at two places in the script:
- <ol>
- <li>After the <code>f_langs=</code> is statement, in lower case.
- <li>In the string that following <code>\@allowed=</code> in upper case.
- </ol>
-The rerun the `configure` script such that is generates `doxygen/src/lang_cfg.h`.
+<li>Create a copy of `doxygen/src/translator_en.h` and name it
+ `doxygen/src/translator_\<your_2_letter_country_code\>.h`
+ I'll use `xx` in the rest of this document (add `XX` for the uppercase version).
+<li> Rerun the `configure` script such that it generates `doxygen/src/lang_cfg.h`.
This file should now contain a \c \#define for your language code.
<li>Edit `doxygen/src/language.cpp`:
Add the following code:
\verbatim
-#ifdef LANG_xx
+#ifdef LANG_XX
#include<translator_xx.h>
#endif
\endverbatim
- Remember to use the same symbol `LANG_xx` that you added to \c lang_cfg.h.
- I.e., the \c xx should be capital letters that identify your language.
- On the other hand, the \c xx inside your \c translator_xx.h should use
- lower case.
+ Remember to use the same symbol `LANG_XX` that was added to `doxygen/src/lang_cfg.h`.
<p>Now, in <code>setTranslator()</code> add
\verbatim
-#ifdef LANG_xx
+#ifdef LANG_XX
else if (L_EQUAL("your_language_name"))
{
theTranslator = new TranslatorYourLanguage;
@@ -90,9 +81,7 @@ This file should now contain a \c \#define for your language code.
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 `doxygen/src/libdoxygen.pro.in` and add \c translator_xx.h to
- the \c HEADERS line.
-<li>Edit <code>translator_xx.h</code>:
+<li>Edit <code>doxygen/src/translator_xx.h</code>:
<ul>
<li>Use the UTF-8 capable editor and open the file using the UTF-8 mode.
<li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code>
@@ -113,12 +102,12 @@ This file should now contain a \c \#define for your language code.
the text is expected to be saved using the UTF-8 encoding. Doxygen
will translate the characters to proper \f$\mbox{\LaTeX}\f$ and
leaves the HTML and man output in UTF-8.
- <li> Use HTML codes like \&auml; for an \c a with an \c umlaut (i.e. &auml;).
+ <li> Use HTML codes like `\&auml;` for an \c a with an \c umlaut (i.e. &auml;).
See the HTML specification for the codes.
</ul>
</ul>
<li>Run \c configure and \c make again from the root (i.e. in the \c doxygen
- directory) of the distribution, in order to regenerate the \c Makefiles.
+ directory) of the distribution, in order to regenerate the `Makefile`s.
<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.