diff options
author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2011-08-21 08:11:15 (GMT) |
---|---|---|
committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2011-08-21 08:11:15 (GMT) |
commit | d71a726489094c4fc1cf94f27a6eaa9a9f56a538 (patch) | |
tree | 26df576f6822a144ec9e57d58a5e9cca717ebd7b /doc | |
parent | 9e5aed6d58f0e33ca942f67daa49971d885b0110 (diff) | |
download | Doxygen-d71a726489094c4fc1cf94f27a6eaa9a9f56a538.zip Doxygen-d71a726489094c4fc1cf94f27a6eaa9a9f56a538.tar.gz Doxygen-d71a726489094c4fc1cf94f27a6eaa9a9f56a538.tar.bz2 |
Release-1.7.5.1
Diffstat (limited to 'doc')
-rw-r--r-- | doc/doxysearch_usage.doc | 180 | ||||
-rw-r--r-- | doc/history.doc | 126 | ||||
-rw-r--r-- | doc/language.doc | 9 | ||||
-rw-r--r-- | doc/maintainers.txt | 1 | ||||
-rw-r--r-- | doc/translator_report.txt | 19 |
5 files changed, 10 insertions, 325 deletions
diff --git a/doc/doxysearch_usage.doc b/doc/doxysearch_usage.doc deleted file mode 100644 index 3310d0a..0000000 --- a/doc/doxysearch_usage.doc +++ /dev/null @@ -1,180 +0,0 @@ -/****************************************************************************** - * - * - * - * Copyright (C) 1997-2003 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 - * for any purpose. It is provided "as is" without express or implied warranty. - * See the GNU General Public License for more details. - * - * Documents produced by Doxygen are derivative works derived from the - * input used in their production; they are not affected by this license. - * - */ -/*! \page doxysearch_usage Doxysearch usage - -Doxysearch is a small, fast and highly portable search engine that allows -you to search for strings or words in the documentation generated by -<a href="doxygen_usage.html">doxygen</a> or -in the Qt documentation (see <a href="#searchqt">below</a>). -Doxysearch must be run as a CGI binary. This implies the following: -<ul> -<li> There must be a HTTP daemon running on the system where you want to - install the documentation (the <em>target</em>) -<li> You must have permission to install and execute a CGI binary on the - target. -</ul> -Ask your system administrator or provider if you are unsure if this is possible. - -In order to be able to search fast and efficient, doxysearch does not -search the generated documentation directly. Instead, it uses an -<em>index file</em>, that should be generated with -<a href="doxytag_usage.html">doxytag</a>. The index file is extracted from -the generated HTML files and contains all words and substrings of words -present in the HTML files, in a compact form, together with their -frequencies and links. Although I tried to store all information -as compactly as possible, the size of the index is still quite large. -Usually it is about the same size as the original HTML files. - -I have tried to make the search engine highly portable, because it -must run on the target system. As a result doxysearch does not require the -Qt library. All that is required to build doxysearch is a C++ compiler. -If you are using \c g++ for example, you can build the search engine manually, -by typing: -\verbatim - g++ doxysearch.cpp -o doxysearch -\endverbatim - -<a name="se"></a> -<h3>Generating the search engine</h3> - -To include a search engine in the documentation generated by doxygen -follow these steps: -<ol> -<li>Generate a configuration file with - <a href="doxygen_usage.html">doxygen</a> using the - <code>-g</code> option, if you haven't done this already. - -<li>Edit the search engine section (see section \ref config_search of - the configuration file). - Make sure the \c SEARCHENGINE tag is set to \c YES - and that all paths are correct. - -<li>Use <a href="doxygen_usage.html">doxygen</a> to generate the - documentation. Apart from the documentation, Doxygen will create the - following files: - <ul> - <li>A small shell script. The name of the script is determined by the - \c CGI_NAME tag in the configuration file. - The script is a small wrapper that calls \c doxysearch with - the correct parameters. Using this script allows multiple - search engines for different projects to be present in one directory. - <li>\c search.cfg: this file is a small configuration file - for the search engine. It contains two lines of text. The first line - should be the absolute URL to the documentation. The second line should - be the absolute URL to the CGI script. This information is taken from - the configuration file. - <li>\c search.gif: this is the image that is used for the search button. - </ul> - - \par Note: - On the Windows platform Unix shell scripts cannot be used. - In fact the HTTP daemon that I tried (apache for Windows) only - recognized <code>.cgi</code> files that were renamed - executables (so DOS batch files do not seem to work either). Therefore, - on Windows a small C program will be generated by doxygen. - You should compile and link the program with your favourite - compiler and change the extension of the executable from - <code>.exe</code> to <code>.cgi</code>. - -<li>Copy (or move) the CGI script to the directory where the CGI binaries - are located. - This is usually a special directory on your system or in your - home directory. - Consult the manual of your HTTP daemon or your system administrator to - find out where this directory resides on your system. - -<li>Go to the directory where the generated HTML files are located and run - doxytag as follows: - <pre>doxytag -s search.idx</pre> - This will create a search index with the name <code>search.idx</code>. - Currently the index file <em>must</em> be called like this. - -<li>If you change the location of the search engine or the documentation - and you do not want to regenerate the HTML output, you can simply edit - the generated search.cfg file and run the generated - <a href="installdox_usage.html">installdox</a> script to correct - the links in the documentation. - -</ol> - -<a name="searchqt"> -<h3>Creating a search engine to search in the Qt documentation</h3> -</a> - -Using <code>doxytag</code> and <code>doxysearch</code> it is possible to create a search engine for -the Qt documentation, without needing the sources! -This can be done by carefully following these steps: -<ol> -<li>Go to the html directory of the Qt-distribution: - <pre>cd \$QTDIR/html</pre> -<li>Generate the search index by typing: - <pre>doxytag -s search.idx</pre> - in the directory where the HTML files are located. - This will parse all files and build a search index. - Apart from the file <code>search.idx</code> two other files - will be generated: <code>search.gif</code> and <code>search.cgi</code> - - \par Note: - Doxytag requires quite a large amount of memory to - generate the search index (about 30 MB on my Linux box)! - The resulting index file requires about 3 MB of space on your disk. - -<li>Edit the shell script <code>search.cgi</code> with a text editor. - - Fill in the absolute path to the <code>doxysearch</code> binary after - the <code>DOXYSEARCH=</code> tag. - On my system this becomes: - <pre>DOXYSEARCH=/usr/local/bin/doxysearch</pre> - - Fill in the absolute path to the qt documentation after the - <code>DOXYPATH=</code> tag. - On my system this becomes: - <pre>DOXYPATH=/usr/local/qt/html</pre> -<li> - CGI binaries are usually located in a special directory. - Consult the manual of your HTTP daemon or your system administrator to - find out, where this directory resides on your system. - Copy (or move) the <code>search.cgi</code> script to this directory. - If needed you may change the name of the script. - On my system, this becomes: - <pre>cp search.cgi /usr/local/lib/httpd/cgi-bin/</pre> - -<li>Create a text-file with the name <code>search.cfg</code>. - On the first line, you must put the <em>absolute</em> URL to the Qt - documentation. - Since, I only use the search engine on my own standalone system, I use - the <code>file:</code> protocol. - On the second line, you must put the <em>absolute</em> URL to the - cgi script. - On my system the resulting file looks like this: -\verbatim -file:///usr/local/qt/html -http://blizzard/cgi-bin/search.cgi -\endverbatim - -<li>Add a link to the search engine in the Qt documentation. - On my system, I have put a line -\verbatim -<li><a href="http://blizzard/cgi-bin/search.cgi">Search the documentation<a> -\endverbatim - in the additional information section of the <code>index.html</code> file. -<li>Start your favourite web browser and click on the link. - If everything is OK, you should get a page where you can enter - search terms. -</ol> - -*/ diff --git a/doc/history.doc b/doc/history.doc deleted file mode 100644 index bd20095..0000000 --- a/doc/history.doc +++ /dev/null @@ -1,126 +0,0 @@ -/****************************************************************************** - * - * - * - * Copyright (C) 1997-2008 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 - * for any purpose. It is provided "as is" without express or implied warranty. - * See the GNU General Public License for more details. - * - * Documents produced by Doxygen are derivative works derived from the - * input used in their production; they are not affected by this license. - * - */ - -/*! \page history Doxygen History - -<h2>Version 1.2.0</h2> -<h3>Major new features:</h3> -<ul> -<li>Support for RTF output. -<li>Using the dot tool of the AT\&T's GraphViz package, doxygen can now - generate inheritance diagrams, collaboration diagrams, include - dependency graphs, included by graphs and graphical inheritance overviews. -<li>Function arguments can now be documented with separate comment blocks. -<li>Initializers and macro definitions are now included in the documentation. -<li>Variables and typedefs are now put in their own section. -<li>Old configuration files can be upgraded using the -u option without - loosing any changes. -<li>Using the \\if and \\endif commands, doxygen can conditionally - include documentation blocks. -<li>Added Doc++ like support for member grouping. -<li>Doxygen now has a GUI front-end called doxywizard (based on Qt-2.1) -<li>All info about configuration options is now concentrated in a new - tool called configgen. This tool can generate the configuration - parser and GUI front-end from source templates. -<li>Better support for the using keyword. -<li>New transparent mini logo that is put in the footer of all HTML pages. -<li>Internationalization support for the Polish, Portuguese and Croatian language. -<li>Todo list support. -<li>If the source browser is enabled, for a function, a list of function whose - implementation calls that function, is generated. -<li>All source code fragments are now syntax highlighted in the HTML output. - The colors can be changed using cascading style sheets. -</ul> - -<h2>Version 1.0.0</h2> - -<h3>Major new features:</h3> -<ul> -<li>Support for templates and namespaces. -<li>Internationalization support. Currently supported languages are: - English, Czech, German, Spanish, Finnish, French, Italian, Japanese, - Dutch, and Swedish. -<li>Automatic generation of inheritance diagrams for sub and super classes. -<li>Support for man page, compressed HTML help, and hyperlinked PDF output. -<li>Cross-referencing documentation with source code and source inlining. -<li>LaTeX formulas can be included in the documentation. -<li>Support for parsing Corba and Microsoft IDL. -<li>Images can be included in the documentation. -<li>Improved parsing and preprocessing. -</ul> - -<h2>Version 0.4</h2> - -<h3>Major new features:</h3> -<ul> -<li>LaTeX output generation. -<li>Full JavaDoc support. -<li>Build-in C-preprocessor for correct conditional parsing of source code - that is read by Doxygen. -<li>Build-in HTML to LaTeX converter. This allows you to use HTML tags in - your documentation, while doxygen still generates proper LaTeX output. -<li>Many new commands (there are now more than 60!) to document - more entities, to make the documentation look nicer, and to include - examples or pieces of examples. -<li>Enum types, enum values, typedefs, \#defines, and files can now be - documented. -<li>Completely new documentation, that is now generated by Doxygen. -<li>A lot of small examples are now included. -</ul> - -<h2>Version 0.3</h2> -<h3>Major new features:</h3> -<ul> -<li>A PHP based search engine that allows you to search through the generated - documentation. -<li>A configuration file instead of command-line options. A default - configuration file can be generated - by <a href="doxygen_usage.html">doxygen</a>. -<li>Added an option to generate output for undocumented classes. -<li>Added an option to generate output for private members. -<li>Every page now contains a condensed index page, allowing much faster - navigation through the documentation. -<li>Global and member variables can now be documented. -<li>A project name can now given, which will be included in the - documentation. -</ul> - -<h2>Version 0.2</h2> -<h3>Major new features:</h3> -<ul> -<li>Blocks of code are now parsed. Function calls and variables are - replaced by links to their documentation if possible. -<li>Special example documentation block added. This can be used to - provide cross references between the documentation and some example code. -<li>Documentation blocks can now be placed inside the body of a class. -<li>Documentation blocks with line range may now be created using - special <code>//!</code> C++ line comments. -<li>Unrelated members can now be documented. A page containing a - list of these members is generated. -<li>Added an <code>\\include</code> command to insert blocks of source code - into the documentation. -<li>Warnings are generated for members that are undocumented. -<li>You can now specify your own HTML headers and footers for the - generated pages. -<li>Option added to generated indices containing all external classes - instead of only the used ones. -</ul> - -<h2>Version 0.1</h2> -Initial version. - -*/ diff --git a/doc/language.doc b/doc/language.doc index 9959cd1..bced9a4 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -138,9 +138,9 @@ when the translator was updated. </tr> <tr bgcolor="#ffffff"> <td>French</td> - <td>Xavier Outhier</td> - <td>xouthier at yahoo dot fr</td> - <td>1.6.3</td> + <td>David Martinet<br/>Xavier Outhier</td> + <td>contact at e-concept-applications dot fr<br/>xouthier at yahoo dot fr</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>German</td> @@ -348,7 +348,8 @@ when the translator was updated. \hline Finnish & Antti Laine & {\tt\tiny antti dot a dot laine at tut dot fi} & 1.6.0 \\ \hline - French & Xavier Outhier & {\tt\tiny xouthier at yahoo dot fr} & 1.6.3 \\ + French & David Martinet & {\tt\tiny contact at e-concept-applications dot fr} & up-to-date \\ + ~ & Xavier Outhier & {\tt\tiny xouthier at yahoo dot fr} & ~ \\ \hline German & Peter Grotrian & {\tt\tiny Peter dot Grotrian at pdv-FS dot de} & up-to-date \\ ~ & Jens Seidel & {\tt\tiny jensseidel at users dot sf dot net} & ~ \\ diff --git a/doc/maintainers.txt b/doc/maintainers.txt index 95310f5..c3fa112 100644 --- a/doc/maintainers.txt +++ b/doc/maintainers.txt @@ -64,6 +64,7 @@ TranslatorFinnish Antti Laine: antti dot a dot laine at tut dot fi TranslatorFrench +David Martinet: contact at e-concept-applications dot fr Xavier Outhier: xouthier at yahoo dot fr TranslatorGerman diff --git a/doc/translator_report.txt b/doc/translator_report.txt index 84e1ea0..46cb70f 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -10,7 +10,7 @@ Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Serbian, SerbianCyrilic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian, and Vietnamese. -Of them, 14 translators are up-to-date, 25 translators are based on +Of them, 15 translators are up-to-date, 24 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- @@ -29,6 +29,7 @@ still may be some details listed even for them: TranslatorDanish -- Reimplementation using UTF-8 suggested. TranslatorDutch TranslatorEnglish + TranslatorFrench -- Reimplementation using UTF-8 suggested. TranslatorGerman TranslatorGreek TranslatorPortuguese @@ -52,9 +53,6 @@ must be implemented to become up-to-date: TranslatorItalian 1.7.5 3 methods to implement (1 %) TranslatorEsperanto 1.7.5 3 methods to implement (1 %) TranslatorPolish 1.6.3 7 methods to implement (3 %) - TranslatorFrench 1.6.3 6 methods to implement (2 %) - Note: Reimplementation using UTF-8 suggested. - TranslatorVietnamese 1.6.0 12 methods to implement (5 %) TranslatorSwedish 1.6.0 12 methods to implement (5 %) Note: Reimplementation using UTF-8 suggested. @@ -253,19 +251,10 @@ TranslatorFinnish (TranslatorAdapter_1_6_0) 12 methods to implement (5 %) virtual QCString trIncludesFileIn(const char * name) -TranslatorFrench (TranslatorAdapter_1_6_3) 6 methods to implement (2 %) +TranslatorFrench (Translator) ---------------- - Implements 222 of the required methods (97 %). - - Missing methods (should be implemented): - - virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) - virtual QCString trFileIn(const char * name) - virtual QCString trDirDepGraph(const char * name) - virtual QCString trDirDependency(const char * name) - virtual QCString trCopyright() - virtual QCString trIncludesFileIn(const char * name) + Implements 228 of the required methods (100 %). TranslatorHungarian (TranslatorAdapter_1_4_6) 36 methods to implement (15 %) |