Added Doxyfile.filter to have special characters escaped that would otherwise be dropped by Doxygen

4 files changed, 41 insertions, 3 deletions

diff --git a/CONTRIBUTORS b/CONTRIBUTORS
index 22ac76ad..0354760f 100644
--- a/CONTRIBUTORS
+++ b/CONTRIBUTORS
@@ -1999,6 +1999,8 @@ Ville Skyttä <ville.skytta@iki.fi>
  for adding missing $(LDFLAGS) to the Makefile of the dvbhddevice plugin
  for fixing some spellings in PLUGINS.html and Doxyfile
  for adding '-p' to the cp command in the install-conf target of the Makefile
+ for reporting that some special characters are dropped by Doxygen and thus need to
+ be escaped
 
 Steffen Beyer <cpunk@reactor.de>
  for fixing setting the colored button help after deleting a recording in case the next
diff --git a/Doxyfile b/Doxyfile
index b3ec7297..2bac2e74 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -364,13 +364,13 @@ IMAGE_PATH             =
 # input file. Doxygen will then use the output that the filter program writes 
 # to standard output.
 
-INPUT_FILTER           = 
+INPUT_FILTER           = ./Doxyfile.filter
 
 # 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 
 # files to browse.
 
-FILTER_SOURCE_FILES    = NO
+FILTER_SOURCE_FILES    = YES
 
 #---------------------------------------------------------------------------
 # configuration options related to source browsing
diff --git a/Doxyfile.filter b/Doxyfile.filter
new file mode 100644
index 00000000..7fde9551
--- /dev/null
+++ b/Doxyfile.filter
@@ -0,0 +1,34 @@
+#!/usr/bin/perl
+
+# Filter source files for use with Doxygen.
+#
+# Escapes special characters in comments marked with "///<".
+#
+# Usage: Doxyfile.filter filename
+#
+# See the main source file 'vdr.c' for copyright information and
+# how to reach the author.
+#
+# $Id: Doxyfile.filter 2.1 2013/02/17 10:54:05 kls Exp $
+
+$TAG = "///<";
+
+while (<>) {
+      $t = $_;
+      $p = index($t, $TAG);
+      if ($p >= 0) {
+         $p += length($TAG);
+         print substr($t, 0, $p);
+         $quote = 0;
+         while (1) {
+               $s = substr($t, $p++, 1);
+               last        if ($s eq "");
+               $quote ^= 1 if ($s eq '"');
+               print "\\"  if (!$quote && $s =~ /[\\\@<>]/);
+               print $s;
+               }
+         }
+      else {
+         print $t;
+         }
+      }
diff --git a/HISTORY b/HISTORY
index ce9791b7..9f43a333 100644
--- a/HISTORY
+++ b/HISTORY
@@ -7585,7 +7585,7 @@ Video Disk Recorder Revision History
 - Fixed formatting and removed some superfluous break statements in vdr.c's command
   line option switch.
 
-2013-02-16: Version 1.7.38
+2013-02-17: Version 1.7.38
  
 - Updated the Ukrainian OSD texts (thanks to Yarema Aka Knedlyk).
 - Updated the Estonian OSD texts (thanks to Arthur Konovalov).
@@ -7634,3 +7634,5 @@ Video Disk Recorder Revision History
 - Removed all \return and \param tags from comment lines marked with "///<" for Doxygen.
   There was only a rather small number of these, and I would probably always forget to
   put them in place when writing future comments, so I decided to drop them entirely.
+- Added Doxyfile.filter to have special characters escaped that would otherwise be
+  dropped by Doxygen (reported by Ville Skyttä).