Patch for RTT Doxygen configuration file

"svn diff" patch for rtt/Doxyfile.in on the trunk, to more closely
match what you've already done to the equivalent OCL file. The patch
uses the correct source dir, ignores SVN files, and removes an
undocumented interaction in Doxygen between EXCLUDE and
EXCLUDE_PATTERNS. Tested under Doxygen 1.5.3 on Ubuntu Gutsy. I
presumed that you wanted all the os subdir's ignored.

Hope this is useful.
S

Index: Doxyfile.in
===================================================================

--- Doxyfile.in	(revision 29197)
+++ Doxyfile.in	(working copy)
@@ -459,7 +459,7 @@
  # directories like "/usr/src/myproject". Separate the files or  

directories

  # with spaces.
-INPUT                  = rtt rtt/Orocos.Main.hpp
+INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@
  # If the value of the INPUT tag contains directories, you can use the
  # FILE_PATTERNS tag to specify one or more wildcard pattern (like  
  • .cpp
@@ -472,7 +472,7 @@
                           *.h \
                           *.idl \
                           *.inl \
-			 *.cpp
+                         *.cpp
  # 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.

@@ -484,8 +484,7 @@
  # excluded from the INPUT source files. This way you can easily  

exclude a

  # subdirectory from a directory tree whose root is specified with  

the INPUT tag.

-EXCLUDE                = rtt/boost rtt/impl \
-		         rtt/os/gnulinux rtt/os/xenomai rtt/os/lxrt rtt/os/ecos
+EXCLUDE                =
  # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
  # directories that are symbolic links (a Unix filesystem feature)  

are excluded

@@ -499,7 +498,17 @@
  # against the file with absolute path, so to exclude all test  

directories

  # for example use the pattern */test/*
-EXCLUDE_PATTERNS       = *.Main.hpp
+EXCLUDE_PATTERNS       = */.svn */.svn/* \
+	*/src/boost/* \
+	*/src/impl/* \
+	*/os/gnulinux/* \
+	*/os/xenomai/* \
+	*/os/lxrt/* \
+	*/os/ecos/* \
+	*/os/oro_i386/* \
+	*/os/oro_powerpc/* \
+	*/os/oro_x86_64/* \
+	*/build/*
  # The EXAMPLE_PATH tag can be used to specify one or more files or
  # directories that contain example code fragments that are included  

(see


Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.

Patch for RTT Doxygen configuration file

On Friday 18 April 2008 17:14:12 S Roderick wrote:
> "svn diff" patch for rtt/Doxyfile.in on the trunk, to more closely
> match what you've already done to the equivalent OCL file. The patch
> uses the correct source dir, ignores SVN files, and removes an
> undocumented interaction in Doxygen between EXCLUDE and
> EXCLUDE_PATTERNS. Tested under Doxygen 1.5.3 on Ubuntu Gutsy. I
> presumed that you wanted all the os subdir's ignored.

I've tested this patch but did not see an improvement, or what it exactly
fixes.

When showing a class documentation page, it should read for example:

Attribute Class Template Reference

  1. include <rtt/Attribute.hpp>

With your patch it reads:

Attribute Class Template Reference

  1. include </home/sspr/src/Orocos/trunk/rtt/src/Attribute.hpp>

That's not what users wants to see... What did your patch intend to fix ?

Peter

>
> Hope this is useful.
> S
>
> Index: Doxyfile.in
> ===================================================================
> --- Doxyfile.in (revision 29197)
> +++ Doxyfile.in (working copy)
> @@ -459,7 +459,7 @@
> # directories like "/usr/src/myproject". Separate the files or
> directories
> # with spaces.
>
> -INPUT = rtt rtt/Orocos.Main.hpp
> +INPUT = @CMAKE_CURRENT_SOURCE_DIR@
>
> # If the value of the INPUT tag contains directories, you can use the
> # FILE_PATTERNS tag to specify one or more wildcard pattern (like
> *.cpp
> @@ -472,7 +472,7 @@
> *.h \
> *.idl \
> *.inl \
> - *.cpp
> + *.cpp
>
> # 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.
> @@ -484,8 +484,7 @@
> # excluded from the INPUT source files. This way you can easily
> exclude a
> # subdirectory from a directory tree whose root is specified with
> the INPUT tag.
>
> -EXCLUDE = rtt/boost rtt/impl \
> - rtt/os/gnulinux rtt/os/xenomai rtt/os/lxrt rtt/os/ecos
> +EXCLUDE =
>
> # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
> # directories that are symbolic links (a Unix filesystem feature)
> are excluded
> @@ -499,7 +498,17 @@
> # against the file with absolute path, so to exclude all test
> directories
> # for example use the pattern */test/*
>
> -EXCLUDE_PATTERNS = *.Main.hpp
> +EXCLUDE_PATTERNS = */.svn */.svn/* \
> + */src/boost/* \
> + */src/impl/* \
> + */os/gnulinux/* \
> + */os/xenomai/* \
> + */os/lxrt/* \
> + */os/ecos/* \
> + */os/oro_i386/* \
> + */os/oro_powerpc/* \
> + */os/oro_x86_64/* \
> + */build/*
>
> # The EXAMPLE_PATH tag can be used to specify one or more files or
> # directories that contain example code fragments that are included
> (see