Skip to contentSkip to conversation

Doxygen hyperlinking utilitiy and demo programs

PATCH In review Wolfgang Grandegger 2 participants 3 messages Nov 10, 2006 – Nov 11, 2006

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Doxygen hyperlinking utilitiy and demo programs

Hello,

the attached patch adds the RT-Socket-CAN utility programs as examples to the Doxygen documentation setup. This creates some nice cross reference from the documented API functions to the example code lines and vice versa. In a similar way, the Xenomai demo programs and code snippets could be integrated making it much easier to find example code or the description of an API function used in an example.

Please have a look and comment?

Thanks.

Wolfgang.

rtdm/rtcan.h +8 -0
Index: include/rtdm/rtcan.h
===================================================================
@@ -1116,7 +1116,15 @@
 
 /** @} */
 
+/*!
+ * @anchor Utilities @name CAN test and utility functions
+ * @{ */
+/** @example rtcanconfig.c */
+/** @example rtcansend.c */
+/** @example rtcanrecv.c */
 /** @} */
 
+/** @} */
 
+
 #endif /* _RTCAN_H */
doxygen/Doxyfile-common.in +4 -4
Index: doc/doxygen/Doxyfile-common.in
===================================================================
@@ -383,27 +383,27 @@
 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
 # certain files from those directories.
 
-EXCLUDE_PATTERNS       = 
+EXCLUDE_PATTERNS       = "*.c"
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or 
 # directories that contain example code fragments that are included (see 
 # the \include command).
 
-EXAMPLE_PATH           = 
+EXAMPLE_PATH           = ../../src/utils
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
 # and *.h) to filter out the source-files in the directories. If left 
 # blank all files are included.
 
-EXAMPLE_PATTERNS       = 
+EXAMPLE_PATTERNS       =
 
 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
 # searched for input files to be used with the \include or \dontinclude 
 # commands irrespective of the value of the RECURSIVE tag. 
 # Possible values are YES and NO. If left blank NO is used.
 
-EXAMPLE_RECURSIVE      = NO
+EXAMPLE_RECURSIVE      = YES
 
 # The IMAGE_PATH tag can be used to specify one or more files or 
 # directories that contain image that are included in the documentation (see 
#1 lore raw
Quoted 10 lines · Wolfgang Grandegger

Hello,

the attached patch adds the RT-Socket-CAN utility programs as examples to the Doxygen documentation setup. This creates some nice cross reference from the documented API functions to the example code lines and vice versa. In a similar way, the Xenomai demo programs and code snippets could be integrated making it much easier to find example code or the description of an API function used in an example.

Please have a look and comment?

This is a good idea. The native skin snippets were created with the same idea in mind, it looks like I somehow forgot to finish the work.

Now, about your patch, will not this hunk break some things ?

Quoted 5 lines

# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude

 # certain files from those directories.
doxygen/Doxyfile-common.in +1 -1
-EXCLUDE_PATTERNS       = 
+EXCLUDE_PATTERNS       = "*.c"
Signature · 1 line
					    Gilles Chanteperdrix.
#2 lore raw
Quoted 16 lines · Gilles Chanteperdrix
Quoted 10 lines · Wolfgang Grandegger

Hello,

the attached patch adds the RT-Socket-CAN utility programs as examples to the Doxygen documentation setup. This creates some nice cross reference from the documented API functions to the example code lines and vice versa. In a similar way, the Xenomai demo programs and code snippets could be integrated making it much easier to find example code or the description of an API function used in an example.

Please have a look and comment?

This is a good idea. The native skin snippets were created with the same idea in mind, it looks like I somehow forgot to finish the work.

Quoted 7 lines

Now, about your patch, will not this hunk break some things ?

doxygen/Doxyfile-common.in line 386

Quoted 5 lines

# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude

 # certain files from those directories.
doxygen/Doxyfile-common.in +1 -1
-EXCLUDE_PATTERNS       = 
+EXCLUDE_PATTERNS       = "*.c"

Oops, of course, I wanted to set EXAMPLE_PATTERNS and not EXCLUDE_PATTERNS to refine the selection of example files.

Thanks.

Wolfgang.