summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/faq.doc21
-rw-r--r--doc/translator.py51
-rw-r--r--doc/translator_report.txt19
3 files changed, 61 insertions, 30 deletions
diff --git a/doc/faq.doc b/doc/faq.doc
index af779ae..8bfc3ae 100644
--- a/doc/faq.doc
+++ b/doc/faq.doc
@@ -211,11 +211,11 @@ If you don't mind spending some time on it, there are several options:
"input buffer overflow, can't enlarge buffer because scanner uses REJECT"</b>
This error happens when doxygen lexical scanner has a rule that matches
-more than 16K of input characters in one go. I've seen this happening
-on a very large generated file (\>16K lines), where the built-in preprocessor
-converted it into an empty file (with \>16K of newlines). Another case
+more than 256K of input characters in one go. I've seen this happening
+on a very large generated file (\>256K lines), where the built-in preprocessor
+converted it into an empty file (with \>256K of newlines). Another case
where this might happen is if you have lines in your code with more than
-16K characters.
+256K characters.
If you have run into such a case and want me to fix it, you
should send me a code fragment that triggers the message. To work around
@@ -263,6 +263,19 @@ namespace std {
I'm still looking for someone who can provide me with definitions
for all (relevant) STL classes.
+<li><b>Can I configure doxygen from the command line?</b>
+
+Not via command line options, but doxygen can read from <code>stdin</code>,
+so you can pipe things through it. Here's an example how to override an option
+in a configuration file from the command line (assuming a unix environment):
+
+\verbatim
+( cat Doxyfile ; echo "PROJECT_NUMBER=1.0" ) | doxygen -
+\endverbatim
+
+If multiple options with the same name are specified then doxygen will use
+the last one. To append to an existing option you can use the += operator.
+
<li><b>How did doxygen get its name?</b>
Doxygen got its name from playing with the words
diff --git a/doc/translator.py b/doc/translator.py
index 81c2fe6..a3f7c93 100644
--- a/doc/translator.py
+++ b/doc/translator.py
@@ -10,7 +10,7 @@
translator report only for some languages, pass their codes as arguments
to the script. In that case, the language.doc will not be generated.
Example:
-
+
python translator.py en nl cz
Originally, the script was written in Perl and was known as translator.pl.
@@ -44,6 +44,7 @@
explicitly via script arguments.
2004/07/26 - Better reporting of not-needed adapters.
2004/10/04 - Reporting of not called translator methods added.
+ 2004/10/05 - Modified to check only doxygen/src sources for the previous report.
"""
from __future__ import generators
@@ -1204,7 +1205,7 @@ class TrManager:
# script, of the translator.h, of the translator_adapter.h (see the
# self.__build() for the last two) of all the translator_xx.h files
# and of the template for generating the documentation. So, this
- # time can compared with modification time of the generated
+ # time can be compared with modification time of the generated
# documentation to decide, whether the doc should be re-generated.
self.lastModificationTime = os.path.getmtime(self.script)
@@ -1361,26 +1362,24 @@ class TrManager:
def __getNoTrSourceFilesLst(self):
"""Returns the list of sources to be checked.
- All .cpp files and also .h files that do not declare and define
+ All .cpp files and also .h files that do not declare or define
the translator methods are included in the list. The file names
- are searched in doxygen directory recursively."""
- lst = []
- for path, dirs, files in os.walk(self.doxy_path):
-
- # Files in doxygen/src should be processed first.
- if path == self.doxy_path:
- dirs.remove('src')
- dirs.insert(0, 'src')
+ are searched in doxygen/src directory.
+ """
+ srcdir = os.path.join(self.doxy_path, 'src')
+ files = []
+ for item in os.listdir(srcdir):
+ # Split the bare name to get the extension.
+ name, ext = os.path.splitext(item)
+ ext = ext.lower()
- # Search for names with .cpp extension (case independent)
- # and append them to the output list.
- for fname in files:
- name, ext = os.path.splitext(fname)
- ext = ext.lower()
- if ext == '.cpp' or (ext == '.h' and name.find('translator') == -1):
- lst.append(os.path.join(path, fname))
-
- return lst
+ # Include only .cpp and .h files (case independent) and exclude
+ # the files where the checked identifiers are defined.
+ if ext == '.cpp' or (ext == '.h' and name.find('translator') == -1):
+ fname = os.path.join(srcdir, item)
+ assert os.path.isfile(fname) # assumes no directory with the ext
+ files.append(fname) # full name
+ return files
def __removeUsedInFiles(self, fname, dic):
@@ -1562,12 +1561,12 @@ class TrManager:
if not self.script_argLst:
dic = self.__checkForNotUsedTrMethods()
if dic:
- s = '''WARNING FOR DEVELOPERS: The following translator
- methods are declared in the Translator class but their
- identifiers do not appear in source files. The situation
- should be checked. The .cpp files and .h files excluding
- the 'translator*.h' files were simply searched for
- occurence of the method identifiers:'''
+ s = '''WARNING: The following translator methods are declared
+ in the Translator class but their identifiers do not appear
+ in source files. The situation should be checked. The .cpp
+ files and .h files excluding the '*translator*' files
+ in doxygen/src directory were simply searched for occurence
+ of the method identifiers:'''
f.write('\n' + '=' * 70 + '\n')
f.write(fill(s) + '\n\n')
diff --git a/doc/translator_report.txt b/doc/translator_report.txt
index 2c73b00..9a6959f 100644
--- a/doc/translator_report.txt
+++ b/doc/translator_report.txt
@@ -65,6 +65,25 @@ version of the translator for the language:
TranslatorKoreanEn implements 5 methods
======================================================================
+WARNING: The following translator methods are declared in the
+Translator class but their identifiers do not appear in source files.
+The situation should be checked. The .cpp files and .h files excluding
+the '*translator*' files in doxygen/src directory were simply searched
+for occurence of the method identifiers:
+
+ QCString trBugsAndLimitations()
+ QCString trEnumerationValueDocumentation()
+ QCString trField(bool, bool)
+ QCString trHeaderFiles()
+ QCString trHeaderFilesDescription()
+ QCString trInterfaces()
+ QCString trNoDescriptionAvailable()
+ QCString trPackageDocumentation()
+ QCString trReimplementedForInternalReasons()
+ QCString trSources()
+
+
+======================================================================
Details for translators (classes sorted alphabetically):