Release-1.3.6-20040427

4 files changed, 30 insertions, 9 deletions

diff --git a/doc/Makefile.in b/doc/Makefile.in
index 1c50c08..1e4d818 100644
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -31,6 +31,6 @@ clean:
 language: language.doc 
 
 language.doc: $(wildcard ../src/translator*.h) maintainers.txt language.tpl translator.py
-	python translator.pl
+	python translator.py
 
 FORCE:
diff --git a/doc/commands.doc b/doc/commands.doc
index a7baae6..309a852 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -922,9 +922,28 @@ ALIASES  = "english=\if english" \
   \addindex \\param
   Starts a parameter description for a function parameter with name 
   \<parameter-name\>. Followed by a description of the parameter. 
-  The existence of the parameter is not checked.
-  The text of the paragraph has no special internal structure. All visual
-  enhancement commands may be used inside the paragraph.
+  The existence of the parameter is checked and a warning is given if
+  the documentation of this (or any other) parameter is missing or not
+  present in the function declaration or definition.
+
+  The \\param command has an optional attribute specifying the direction
+  of the attribute. Possible values are "in" and "out". Here is an example
+  for the function memcpy:
+  \code
+/*!
+ * Copies bytes from a source memory area to a destination memory area,
+ * where both areas may not overlap.
+ * @param[out] dest The memory area to copy to.
+ * @param[in]  src  The memory area to copy from.
+ * @param[in]  n    The number of bytes to copy
+ */
+void memcpy(void *dest, const void *src, size_t n);
+  \endcode
+  If a parameter is both input and output, use [in,out] as an attribute.
+
+  The parameter description is a paragraph with no special internal structure. 
+  All visual enhancement commands may be used inside the paragraph.
+
   Multiple adjacent \\param commands will be joined into a single paragraph.
   Each parameter description will start on a new line.
   The \\param description ends when a blank line or some other 
diff --git a/doc/index.doc b/doc/index.doc
index 4956018..6aa4c19 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -26,8 +26,8 @@ Version: $(VERSION)
 \endif
 
 <h2>Introduction</h2>
-Doxygen is a documentation system for C++, C, Java, IDL 
-(Corba and Microsoft flavors) and to some extent Objective-C, PHP, C# and D. 
+Doxygen is a documentation system for C++, C, Java, Objective-C, IDL 
+(Corba and Microsoft flavors) and to some extent PHP, C# and D. 
 
 It can help you in three ways:
 <ol>
diff --git a/doc/translator.py b/doc/translator.py
index 4ec7d2f..8a8b99f 100644
--- a/doc/translator.py
+++ b/doc/translator.py
@@ -38,8 +38,8 @@
      but is much less tricky and much more flexible. It also solves some
      problems that were not solved by the Perl version. The translator report
      content should be more useful for developers.
-  2004/02/11
-   - Some tuning-up to provide more useful information.
+  2004/02/11 - Some tuning-up to provide more useful information.
+  2004/04/16 - Added new tokens to the tokenizer (to remove some warnings).
   """                               
 
 import os, re, sys, textwrap
@@ -127,6 +127,8 @@ class Transl:
                      '"':         'dquot',
                      '.':         'dot',
                      '%':         'perc',
+                     '~':         'tilde',
+                     '^':         'caret',
                    }
         
         # Regular expression for recognizing identifiers.
@@ -180,7 +182,7 @@ class Transl:
                         else:
                             msg = '\aWarning: unknown token "' + tokenStr + '"'
                             msg += '\tfound on line %d' % tokenLineNo 
-                            msg += 'in "' + self.fname + '".\n'
+                            msg += ' in "' + self.fname + '".\n'
                             sys.stderr.write(msg)
                     
                     yield (tokenId, tokenStr, tokenLineNo)