r20266 - gnucash/trunk/src/doc - Bug #640357: Adding very limited Perl-Support for doxygen

[Christian Stimming]

Author: cstim
Date: 2011-02-10 14:40:22 -0500 (Thu, 10 Feb 2011)
New Revision: 20266
Trac: http://svn.gnucash.org/trac/changeset/20266

Modified:
   gnucash/trunk/src/doc/doxygen.cfg.in
Log:
Bug #640357: Adding very limited Perl-Support for doxygen

There are a few Perl-scripts scattered through the GnuCash sources. This patch
enables doxygen to interpret them so that they can be provided with information
about author, date and so on.

This is done by telling doxygen that their python-files. So python-comments can
be used.

The actual Perl-source is commented out by using
@cond Perl
..PERL-CODE...
@endcond Perl

Patch by Christoph Holtermann

Modified: gnucash/trunk/src/doc/doxygen.cfg.in
===================================================================
--- gnucash/trunk/src/doc/doxygen.cfg.in	2011-02-10 19:37:23 UTC (rev 20265)
+++ gnucash/trunk/src/doc/doxygen.cfg.in	2011-02-10 19:40:22 UTC (rev 20266)
@@ -573,7 +573,8 @@
 FILE_PATTERNS          = *.c \
                          *.h \
                          *.txt \
-			 *.py
+			 *.py \
+			 *.pl
 
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
 # should be searched for input files as well. Possible values are YES and NO. 
@@ -643,7 +644,7 @@
 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
 # ignored.
 
-INPUT_FILTER           = 
+INPUT_FILTER           =  
 
 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
 # basis.  Doxygen will compare the file name with each pattern and apply the 
@@ -652,7 +653,7 @@
 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
 # is applied to all files.
 
-FILTER_PATTERNS        = 
+FILTER_PATTERNS        =  
 
 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
 # INPUT_FILTER) will be used to filter the input files when producing source 
@@ -1475,3 +1476,10 @@
 # used. If set to NO the values of all tags below this one will be ignored.
 
 SEARCHENGINE           = YES
+
+# Interpret Perl-files like Python-files for there is no support for Perl
+# in Doxygen. The whole Perl-Code should be wrapped in @cond Perl @endcon Perl
+# so that it will be ignored. Information about the file can thus be put in the
+# beginning of the file.
+
+EXTENSION_MAPPING	= pl=python