<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>change log for rtems (2010-06-12)</title>
</head>
<body text='#000000' bgcolor='#ffffff'>
<a name='cs1'></a>
<table border='0' cellspacing='0' cellpadding='5' width='100%' bgcolor='#eeeeee'>
<tr><td colspan='3' bgcolor='#dddddd'>
<font color='#bb2222'><strong>ralf</strong></font>
<font color='#225522'><em>(on branch rtems-4-10-branch)</em></font>
</td></tr>
<tr><td colspan='3' bgcolor='#dddddd'><pre>2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
* libfs/src/devfs/devfs.h, libfs/src/rfs/rtems-rfs-block-pos.h,
libfs/src/rfs/rtems-rfs-block.h, libfs/src/rfs/rtems-rfs-dir.h,
libfs/src/rfs/rtems-rfs-group.h, libfs/src/rfs/rtems-rfs-inode.h:
Fix broken doxygen commands.
</pre></td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/ChangeLog.diff?r1=text&tr1=1.2368&r2=text&tr2=1.2369&diff_format=h">M</a></td><td width='1%'>1.2369</td><td width='100%'>cpukit/ChangeLog</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/ChangeLog.diff?r1=text&tr1=1.2346.2.3&r2=text&tr2=1.2346.2.4&diff_format=h">M</a></td><td width='1%'>1.2346.2.4</td><td width='100%'>cpukit/ChangeLog</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/libfs/src/devfs/devfs.h.diff?r1=text&tr1=1.7&r2=text&tr2=1.8&diff_format=h">M</a></td><td width='1%'>1.8</td><td width='100%'>cpukit/libfs/src/devfs/devfs.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/libfs/src/devfs/devfs.h.diff?r1=text&tr1=1.7&r2=text&tr2=1.7.2.1&diff_format=h">M</a></td><td width='1%'>1.7.2.1</td><td width='100%'>cpukit/libfs/src/devfs/devfs.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h.diff?r1=text&tr1=1.1&r2=text&tr2=1.2&diff_format=h">M</a></td><td width='1%'>1.2</td><td width='100%'>cpukit/libfs/src/rfs/rtems-rfs-block-pos.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h.diff?r1=text&tr1=1.1&r2=text&tr2=1.1.2.1&diff_format=h">M</a></td><td width='1%'>1.1.2.1</td><td width='100%'>cpukit/libfs/src/rfs/rtems-rfs-block-pos.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/libfs/src/rfs/rtems-rfs-block.h.diff?r1=text&tr1=1.1&r2=text&tr2=1.2&diff_format=h">M</a></td><td width='1%'>1.2</td><td width='100%'>cpukit/libfs/src/rfs/rtems-rfs-block.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/libfs/src/rfs/rtems-rfs-block.h.diff?r1=text&tr1=1.1&r2=text&tr2=1.1.2.1&diff_format=h">M</a></td><td width='1%'>1.1.2.1</td><td width='100%'>cpukit/libfs/src/rfs/rtems-rfs-block.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/libfs/src/rfs/rtems-rfs-dir.h.diff?r1=text&tr1=1.1&r2=text&tr2=1.2&diff_format=h">M</a></td><td width='1%'>1.2</td><td width='100%'>cpukit/libfs/src/rfs/rtems-rfs-dir.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/libfs/src/rfs/rtems-rfs-dir.h.diff?r1=text&tr1=1.1&r2=text&tr2=1.1.2.1&diff_format=h">M</a></td><td width='1%'>1.1.2.1</td><td width='100%'>cpukit/libfs/src/rfs/rtems-rfs-dir.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/libfs/src/rfs/rtems-rfs-group.h.diff?r1=text&tr1=1.2&r2=text&tr2=1.3&diff_format=h">M</a></td><td width='1%'>1.3</td><td width='100%'>cpukit/libfs/src/rfs/rtems-rfs-group.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/libfs/src/rfs/rtems-rfs-group.h.diff?r1=text&tr1=1.2&r2=text&tr2=1.2.2.1&diff_format=h">M</a></td><td width='1%'>1.2.2.1</td><td width='100%'>cpukit/libfs/src/rfs/rtems-rfs-group.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/libfs/src/rfs/rtems-rfs-inode.h.diff?r1=text&tr1=1.3&r2=text&tr2=1.4&diff_format=h">M</a></td><td width='1%'>1.4</td><td width='100%'>cpukit/libfs/src/rfs/rtems-rfs-inode.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/libfs/src/rfs/rtems-rfs-inode.h.diff?r1=text&tr1=1.3&r2=text&tr2=1.3.2.1&diff_format=h">M</a></td><td width='1%'>1.3.2.1</td><td width='100%'>cpukit/libfs/src/rfs/rtems-rfs-inode.h</td></tr>
</table>
<pre>
<font color='#006600'>diff -u rtems/cpukit/ChangeLog:1.2368 rtems/cpukit/ChangeLog:1.2369
--- rtems/cpukit/ChangeLog:1.2368 Fri Jun 11 14:37:12 2010
+++ rtems/cpukit/ChangeLog Sat Jun 12 00:18:16 2010
</font><font color='#997700'>@@ -1,3 +1,10 @@
</font><font color='#000088'>+2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
+
+ * libfs/src/devfs/devfs.h, libfs/src/rfs/rtems-rfs-block-pos.h,
+ libfs/src/rfs/rtems-rfs-block.h, libfs/src/rfs/rtems-rfs-dir.h,
+ libfs/src/rfs/rtems-rfs-group.h, libfs/src/rfs/rtems-rfs-inode.h:
+ Fix broken doxygen commands.
+
</font> 2010-06-11 Ralf Corsépius <ralf.corsepius@rtems.org>
* Doxygen.in: Update.
<font color='#006600'>diff -u rtems/cpukit/ChangeLog:1.2346.2.3 rtems/cpukit/ChangeLog:1.2346.2.4
--- rtems/cpukit/ChangeLog:1.2346.2.3 Tue Jun 8 23:39:15 2010
+++ rtems/cpukit/ChangeLog Sat Jun 12 00:19:25 2010
</font><font color='#997700'>@@ -1,3 +1,10 @@
</font><font color='#000088'>+2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
+
+ * libfs/src/devfs/devfs.h, libfs/src/rfs/rtems-rfs-block-pos.h,
+ libfs/src/rfs/rtems-rfs-block.h, libfs/src/rfs/rtems-rfs-dir.h,
+ libfs/src/rfs/rtems-rfs-group.h, libfs/src/rfs/rtems-rfs-inode.h:
+ Fix broken doxygen commands.
+
</font> 2010-06-09 Ralf Corsépius <ralf.corsepius@rtems.org>
* configure.ac: Remove nios2 (unsupported, no toolchain).
<font color='#006600'>diff -u rtems/cpukit/libfs/src/devfs/devfs.h:1.7 rtems/cpukit/libfs/src/devfs/devfs.h:1.8
--- rtems/cpukit/libfs/src/devfs/devfs.h:1.7 Mon May 31 08:56:36 2010
+++ rtems/cpukit/libfs/src/devfs/devfs.h Sat Jun 12 00:18:02 2010
</font><font color='#997700'>@@ -267,7 +267,6 @@
</font> * This routine is intended for debugging, and can be used by shell
* program to provide user with the system information.
*
<font color='#880000'>- * @param none
</font> * @retval 0
*/
<font color='#006600'>diff -u rtems/cpukit/libfs/src/devfs/devfs.h:1.7 rtems/cpukit/libfs/src/devfs/devfs.h:1.7.2.1
--- rtems/cpukit/libfs/src/devfs/devfs.h:1.7 Mon May 31 08:56:36 2010
+++ rtems/cpukit/libfs/src/devfs/devfs.h Sat Jun 12 00:19:11 2010
</font><font color='#997700'>@@ -267,7 +267,6 @@
</font> * This routine is intended for debugging, and can be used by shell
* program to provide user with the system information.
*
<font color='#880000'>- * @param none
</font> * @retval 0
*/
<font color='#006600'>diff -u rtems/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h:1.1 rtems/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h:1.2
--- rtems/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h:1.1 Wed Feb 17 18:24:24 2010
+++ rtems/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h Sat Jun 12 00:18:02 2010
</font><font color='#997700'>@@ -72,7 +72,7 @@
</font> * Copy a block position.
*
* @param _lhs The left hand side.
<font color='#880000'>- * @parma _rhs The right handl side.
</font><font color='#000088'>+ * @param _rhs The right hand side.
</font> */
#define rtems_rfs_block_copy_bpos(_lhs, _rhs) \
do { (_lhs)->bno = (_rhs)->bno; \
<font color='#997700'>@@ -156,7 +156,7 @@
</font> * Copy a block size.
*
* @param _lhs The left hand side.
<font color='#880000'>- * @parma _rhs The right handl side.
</font><font color='#000088'>+ * @param _rhs The right hand side.
</font> */
#define rtems_rfs_block_copy_size(_lhs, _rhs) \
do { (_lhs)->count = (_rhs)->count; \
<font color='#006600'>diff -u rtems/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h:1.1 rtems/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h:1.1.2.1
--- rtems/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h:1.1 Wed Feb 17 18:24:24 2010
+++ rtems/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h Sat Jun 12 00:19:11 2010
</font><font color='#997700'>@@ -72,7 +72,7 @@
</font> * Copy a block position.
*
* @param _lhs The left hand side.
<font color='#880000'>- * @parma _rhs The right handl side.
</font><font color='#000088'>+ * @param _rhs The right hand side.
</font> */
#define rtems_rfs_block_copy_bpos(_lhs, _rhs) \
do { (_lhs)->bno = (_rhs)->bno; \
<font color='#997700'>@@ -156,7 +156,7 @@
</font> * Copy a block size.
*
* @param _lhs The left hand side.
<font color='#880000'>- * @parma _rhs The right handl side.
</font><font color='#000088'>+ * @param _rhs The right hand side.
</font> */
#define rtems_rfs_block_copy_size(_lhs, _rhs) \
do { (_lhs)->count = (_rhs)->count; \
<font color='#006600'>diff -u rtems/cpukit/libfs/src/rfs/rtems-rfs-block.h:1.1 rtems/cpukit/libfs/src/rfs/rtems-rfs-block.h:1.2
--- rtems/cpukit/libfs/src/rfs/rtems-rfs-block.h:1.1 Wed Feb 17 18:24:24 2010
+++ rtems/cpukit/libfs/src/rfs/rtems-rfs-block.h Sat Jun 12 00:18:02 2010
</font><font color='#997700'>@@ -201,7 +201,7 @@
</font> * so a seek of offset 0 will return the first block.
*
* @param fs The file system data.
<font color='#880000'>- * @prarm inode The inode the map belongs to.
</font><font color='#000088'>+ * @param inode The inode the map belongs to.
</font> * @param map The map that is opened.
* @return int The error number (errno). No error if 0.
*/
<font color='#006600'>diff -u rtems/cpukit/libfs/src/rfs/rtems-rfs-block.h:1.1 rtems/cpukit/libfs/src/rfs/rtems-rfs-block.h:1.1.2.1
--- rtems/cpukit/libfs/src/rfs/rtems-rfs-block.h:1.1 Wed Feb 17 18:24:24 2010
+++ rtems/cpukit/libfs/src/rfs/rtems-rfs-block.h Sat Jun 12 00:19:11 2010
</font><font color='#997700'>@@ -201,7 +201,7 @@
</font> * so a seek of offset 0 will return the first block.
*
* @param fs The file system data.
<font color='#880000'>- * @prarm inode The inode the map belongs to.
</font><font color='#000088'>+ * @param inode The inode the map belongs to.
</font> * @param map The map that is opened.
* @return int The error number (errno). No error if 0.
*/
<font color='#006600'>diff -u rtems/cpukit/libfs/src/rfs/rtems-rfs-dir.h:1.1 rtems/cpukit/libfs/src/rfs/rtems-rfs-dir.h:1.2
--- rtems/cpukit/libfs/src/rfs/rtems-rfs-dir.h:1.1 Wed Feb 17 18:24:25 2010
+++ rtems/cpukit/libfs/src/rfs/rtems-rfs-dir.h Sat Jun 12 00:18:02 2010
</font><font color='#997700'>@@ -83,7 +83,7 @@
</font> * Set the hash of the entry.
*
* @param _e Pointer to the directory entry.
<font color='#880000'>- * @aparam _h The hash.
</font><font color='#000088'>+ * @param _h The hash.
</font> */
#define rtems_rfs_dir_set_entry_hash(_e, _h) \
rtems_rfs_write_u32 (_e + RTEMS_RFS_DIR_ENTRY_HASH, _h)
<font color='#997700'>@@ -138,7 +138,7 @@
</font> */
int rtems_rfs_dir_lookup_ino (rtems_rfs_file_system* fs,
rtems_rfs_inode_handle* inode,
<font color='#880000'>- const char* path,
</font><font color='#000088'>+ const char* name,
</font> int length,
rtems_rfs_ino* ino,
uint32_t* offset);
<font color='#997700'>@@ -150,7 +150,7 @@
</font> * @param fs The file system data.
* @param dir Pointer to the directory inode the entry is to be added too.
* @param name The name of the entry to be added.
<font color='#880000'>- * @param length The length of the name excluding a terminating \0.
</font><font color='#000088'>+ * @param length The length of the name excluding a terminating 0.
</font> * @param ino The ino of the entry.
* @return int The error number (errno). No error if 0.
*/
<font color='#006600'>diff -u rtems/cpukit/libfs/src/rfs/rtems-rfs-dir.h:1.1 rtems/cpukit/libfs/src/rfs/rtems-rfs-dir.h:1.1.2.1
--- rtems/cpukit/libfs/src/rfs/rtems-rfs-dir.h:1.1 Wed Feb 17 18:24:25 2010
+++ rtems/cpukit/libfs/src/rfs/rtems-rfs-dir.h Sat Jun 12 00:19:11 2010
</font><font color='#997700'>@@ -83,7 +83,7 @@
</font> * Set the hash of the entry.
*
* @param _e Pointer to the directory entry.
<font color='#880000'>- * @aparam _h The hash.
</font><font color='#000088'>+ * @param _h The hash.
</font> */
#define rtems_rfs_dir_set_entry_hash(_e, _h) \
rtems_rfs_write_u32 (_e + RTEMS_RFS_DIR_ENTRY_HASH, _h)
<font color='#997700'>@@ -138,7 +138,7 @@
</font> */
int rtems_rfs_dir_lookup_ino (rtems_rfs_file_system* fs,
rtems_rfs_inode_handle* inode,
<font color='#880000'>- const char* path,
</font><font color='#000088'>+ const char* name,
</font> int length,
rtems_rfs_ino* ino,
uint32_t* offset);
<font color='#997700'>@@ -150,7 +150,7 @@
</font> * @param fs The file system data.
* @param dir Pointer to the directory inode the entry is to be added too.
* @param name The name of the entry to be added.
<font color='#880000'>- * @param length The length of the name excluding a terminating \0.
</font><font color='#000088'>+ * @param length The length of the name excluding a terminating 0.
</font> * @param ino The ino of the entry.
* @return int The error number (errno). No error if 0.
*/
<font color='#006600'>diff -u rtems/cpukit/libfs/src/rfs/rtems-rfs-group.h:1.2 rtems/cpukit/libfs/src/rfs/rtems-rfs-group.h:1.3
--- rtems/cpukit/libfs/src/rfs/rtems-rfs-group.h:1.2 Mon Feb 22 17:02:41 2010
+++ rtems/cpukit/libfs/src/rfs/rtems-rfs-group.h Sat Jun 12 00:18:02 2010
</font><font color='#997700'>@@ -127,7 +127,7 @@
</font> *
* @param fs The file system data.
* @param inode If true the number to free is an inode else it is a block.
<font color='#880000'>- * @prarm block The inode or block number to free.
</font><font color='#000088'>+ * @param block The inode or block number to free.
</font> * @return int The error number (errno). No error if 0.
*/
int rtems_rfs_group_bitmap_free (rtems_rfs_file_system* fs,
<font color='#997700'>@@ -139,8 +139,8 @@
</font> *
* @param fs The file system data.
* @param inode If true the number to free is an inode else it is a block.
<font color='#880000'>- * @prarm block The inode or block number to free.
- * @prarm state Return the state of the bit.
</font><font color='#000088'>+ * @param block The inode or block number to free.
+ * @param state Return the state of the bit.
</font> * @return int The error number (errno). No error if 0.
*/
int rtems_rfs_group_bitmap_test (rtems_rfs_file_system* fs,
<font color='#997700'>@@ -152,7 +152,7 @@
</font> * Determine the number of blocks and inodes used.
*
* @param fs The file system data.
<font color='#880000'>- * @prarm blocks The number of blocks used.
</font><font color='#000088'>+ * @param blocks The number of blocks used.
</font> * @param inodes The number of inodes used.
* @return int The error number (errno). No error if 0.
*/
<font color='#006600'>diff -u rtems/cpukit/libfs/src/rfs/rtems-rfs-group.h:1.2 rtems/cpukit/libfs/src/rfs/rtems-rfs-group.h:1.2.2.1
--- rtems/cpukit/libfs/src/rfs/rtems-rfs-group.h:1.2 Mon Feb 22 17:02:41 2010
+++ rtems/cpukit/libfs/src/rfs/rtems-rfs-group.h Sat Jun 12 00:19:11 2010
</font><font color='#997700'>@@ -127,7 +127,7 @@
</font> *
* @param fs The file system data.
* @param inode If true the number to free is an inode else it is a block.
<font color='#880000'>- * @prarm block The inode or block number to free.
</font><font color='#000088'>+ * @param block The inode or block number to free.
</font> * @return int The error number (errno). No error if 0.
*/
int rtems_rfs_group_bitmap_free (rtems_rfs_file_system* fs,
<font color='#997700'>@@ -139,8 +139,8 @@
</font> *
* @param fs The file system data.
* @param inode If true the number to free is an inode else it is a block.
<font color='#880000'>- * @prarm block The inode or block number to free.
- * @prarm state Return the state of the bit.
</font><font color='#000088'>+ * @param block The inode or block number to free.
+ * @param state Return the state of the bit.
</font> * @return int The error number (errno). No error if 0.
*/
int rtems_rfs_group_bitmap_test (rtems_rfs_file_system* fs,
<font color='#997700'>@@ -152,7 +152,7 @@
</font> * Determine the number of blocks and inodes used.
*
* @param fs The file system data.
<font color='#880000'>- * @prarm blocks The number of blocks used.
</font><font color='#000088'>+ * @param blocks The number of blocks used.
</font> * @param inodes The number of inodes used.
* @return int The error number (errno). No error if 0.
*/
<font color='#006600'>diff -u rtems/cpukit/libfs/src/rfs/rtems-rfs-inode.h:1.3 rtems/cpukit/libfs/src/rfs/rtems-rfs-inode.h:1.4
--- rtems/cpukit/libfs/src/rfs/rtems-rfs-inode.h:1.3 Mon Apr 12 00:29:25 2010
+++ rtems/cpukit/libfs/src/rfs/rtems-rfs-inode.h Sat Jun 12 00:18:02 2010
</font><font color='#997700'>@@ -576,7 +576,7 @@
</font> * the supporting calls.
*
* @param fs The file system.
<font color='#880000'>- * @parma ino The inode number.
</font><font color='#000088'>+ * @param ino The inode number.
</font> * @param handle The handle to the inode we are opening.
* @param load If true load the inode into memory from the media.
* @return int The error number (errno). No error if 0.
<font color='#997700'>@@ -682,7 +682,7 @@
</font> * Calculate the size of data attached to the inode.
*
* @param fs The file system data.
<font color='#880000'>- * @oaram handle The inode handle.
</font><font color='#000088'>+ * @param handle The inode handle.
</font> * @return rtems_rfs_pos The data size in bytes in the block map attched to the
* inode.
*/
<font color='#006600'>diff -u rtems/cpukit/libfs/src/rfs/rtems-rfs-inode.h:1.3 rtems/cpukit/libfs/src/rfs/rtems-rfs-inode.h:1.3.2.1
--- rtems/cpukit/libfs/src/rfs/rtems-rfs-inode.h:1.3 Mon Apr 12 00:29:25 2010
+++ rtems/cpukit/libfs/src/rfs/rtems-rfs-inode.h Sat Jun 12 00:19:11 2010
</font><font color='#997700'>@@ -576,7 +576,7 @@
</font> * the supporting calls.
*
* @param fs The file system.
<font color='#880000'>- * @parma ino The inode number.
</font><font color='#000088'>+ * @param ino The inode number.
</font> * @param handle The handle to the inode we are opening.
* @param load If true load the inode into memory from the media.
* @return int The error number (errno). No error if 0.
<font color='#997700'>@@ -682,7 +682,7 @@
</font> * Calculate the size of data attached to the inode.
*
* @param fs The file system data.
<font color='#880000'>- * @oaram handle The inode handle.
</font><font color='#000088'>+ * @param handle The inode handle.
</font> * @return rtems_rfs_pos The data size in bytes in the block map attched to the
* inode.
*/
</pre>
<p> </p>
<a name='cs2'></a>
<table border='0' cellspacing='0' cellpadding='5' width='100%' bgcolor='#eeeeee'>
<tr><td colspan='3' bgcolor='#dddddd'>
<font color='#bb2222'><strong>ralf</strong></font>
<font color='#225522'><em>(on branch rtems-4-10-branch)</em></font>
</td></tr>
<tr><td colspan='3' bgcolor='#dddddd'><pre>2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
* posix/include/devctl.h: Move mal-placed @file.
</pre></td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/ChangeLog.diff?r1=text&tr1=1.2369&r2=text&tr2=1.2370&diff_format=h">M</a></td><td width='1%'>1.2370</td><td width='100%'>cpukit/ChangeLog</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/ChangeLog.diff?r1=text&tr1=1.2346.2.4&r2=text&tr2=1.2346.2.5&diff_format=h">M</a></td><td width='1%'>1.2346.2.5</td><td width='100%'>cpukit/ChangeLog</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/posix/include/devctl.h.diff?r1=text&tr1=1.8&r2=text&tr2=1.9&diff_format=h">M</a></td><td width='1%'>1.9</td><td width='100%'>cpukit/posix/include/devctl.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/posix/include/devctl.h.diff?r1=text&tr1=1.8&r2=text&tr2=1.8.4.1&diff_format=h">M</a></td><td width='1%'>1.8.4.1</td><td width='100%'>cpukit/posix/include/devctl.h</td></tr>
</table>
<pre>
<font color='#006600'>diff -u rtems/cpukit/ChangeLog:1.2369 rtems/cpukit/ChangeLog:1.2370
--- rtems/cpukit/ChangeLog:1.2369 Sat Jun 12 00:18:16 2010
+++ rtems/cpukit/ChangeLog Sat Jun 12 00:52:39 2010
</font><font color='#997700'>@@ -1,5 +1,9 @@
</font> 2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
<font color='#000088'>+ * posix/include/devctl.h: Move mal-placed @file.
+
+2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
+
</font> * libfs/src/devfs/devfs.h, libfs/src/rfs/rtems-rfs-block-pos.h,
libfs/src/rfs/rtems-rfs-block.h, libfs/src/rfs/rtems-rfs-dir.h,
libfs/src/rfs/rtems-rfs-group.h, libfs/src/rfs/rtems-rfs-inode.h:
<font color='#006600'>diff -u rtems/cpukit/ChangeLog:1.2346.2.4 rtems/cpukit/ChangeLog:1.2346.2.5
--- rtems/cpukit/ChangeLog:1.2346.2.4 Sat Jun 12 00:19:25 2010
+++ rtems/cpukit/ChangeLog Sat Jun 12 00:52:35 2010
</font><font color='#997700'>@@ -1,5 +1,9 @@
</font> 2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
<font color='#000088'>+ * posix/include/devctl.h: Move mal-placed @file.
+
+2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
+
</font> * libfs/src/devfs/devfs.h, libfs/src/rfs/rtems-rfs-block-pos.h,
libfs/src/rfs/rtems-rfs-block.h, libfs/src/rfs/rtems-rfs-dir.h,
libfs/src/rfs/rtems-rfs-group.h, libfs/src/rfs/rtems-rfs-inode.h:
<font color='#006600'>diff -u rtems/cpukit/posix/include/devctl.h:1.8 rtems/cpukit/posix/include/devctl.h:1.9
--- rtems/cpukit/posix/include/devctl.h:1.8 Mon Dec 17 10:19:13 2007
+++ rtems/cpukit/posix/include/devctl.h Sat Jun 12 00:52:39 2010
</font><font color='#997700'>@@ -1,4 +1,5 @@
</font> /**
<font color='#000088'>+ * @file devctl.h
</font> */
/*
<font color='#997700'>@@ -9,7 +10,6 @@
</font> * found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*
<font color='#880000'>- * @file devctl.h
</font> * $Id$
*/
<font color='#006600'>diff -u rtems/cpukit/posix/include/devctl.h:1.8 rtems/cpukit/posix/include/devctl.h:1.8.4.1
--- rtems/cpukit/posix/include/devctl.h:1.8 Mon Dec 17 10:19:13 2007
+++ rtems/cpukit/posix/include/devctl.h Sat Jun 12 00:52:36 2010
</font><font color='#997700'>@@ -1,4 +1,5 @@
</font> /**
<font color='#000088'>+ * @file devctl.h
</font> */
/*
<font color='#997700'>@@ -9,7 +10,6 @@
</font> * found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*
<font color='#880000'>- * @file devctl.h
</font> * $Id$
*/
</pre>
<p> </p>
<a name='cs3'></a>
<table border='0' cellspacing='0' cellpadding='5' width='100%' bgcolor='#eeeeee'>
<tr><td colspan='3' bgcolor='#dddddd'>
<font color='#bb2222'><strong>ralf</strong></font>
<font color='#225522'><em>(on branch rtems-4-10-branch)</em></font>
</td></tr>
<tr><td colspan='3' bgcolor='#dddddd'><pre>2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
* score/include/rtems/score/timestamp.h,
score/include/rtems/score/timestamp64.h,
score/include/rtems/score/watchdog.h:
Misc. doxygen fixes.
</pre></td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/ChangeLog.diff?r1=text&tr1=1.2370&r2=text&tr2=1.2371&diff_format=h">M</a></td><td width='1%'>1.2371</td><td width='100%'>cpukit/ChangeLog</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/ChangeLog.diff?r1=text&tr1=1.2346.2.5&r2=text&tr2=1.2346.2.6&diff_format=h">M</a></td><td width='1%'>1.2346.2.6</td><td width='100%'>cpukit/ChangeLog</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/score/include/rtems/score/timestamp.h.diff?r1=text&tr1=1.3&r2=text&tr2=1.4&diff_format=h">M</a></td><td width='1%'>1.4</td><td width='100%'>cpukit/score/include/rtems/score/timestamp.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/score/include/rtems/score/timestamp.h.diff?r1=text&tr1=1.3&r2=text&tr2=1.3.2.1&diff_format=h">M</a></td><td width='1%'>1.3.2.1</td><td width='100%'>cpukit/score/include/rtems/score/timestamp.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/score/include/rtems/score/timestamp64.h.diff?r1=text&tr1=1.2&r2=text&tr2=1.3&diff_format=h">M</a></td><td width='1%'>1.3</td><td width='100%'>cpukit/score/include/rtems/score/timestamp64.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/score/include/rtems/score/timestamp64.h.diff?r1=text&tr1=1.2&r2=text&tr2=1.2.2.1&diff_format=h">M</a></td><td width='1%'>1.2.2.1</td><td width='100%'>cpukit/score/include/rtems/score/timestamp64.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/score/include/rtems/score/watchdog.h.diff?r1=text&tr1=1.29&r2=text&tr2=1.30&diff_format=h">M</a></td><td width='1%'>1.30</td><td width='100%'>cpukit/score/include/rtems/score/watchdog.h</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/score/include/rtems/score/watchdog.h.diff?r1=text&tr1=1.29&r2=text&tr2=1.29.2.1&diff_format=h">M</a></td><td width='1%'>1.29.2.1</td><td width='100%'>cpukit/score/include/rtems/score/watchdog.h</td></tr>
</table>
<pre>
<font color='#006600'>diff -u rtems/cpukit/ChangeLog:1.2370 rtems/cpukit/ChangeLog:1.2371
--- rtems/cpukit/ChangeLog:1.2370 Sat Jun 12 00:52:39 2010
+++ rtems/cpukit/ChangeLog Sat Jun 12 00:56:26 2010
</font><font color='#997700'>@@ -1,5 +1,12 @@
</font> 2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
<font color='#000088'>+ * score/include/rtems/score/timestamp.h,
+ score/include/rtems/score/timestamp64.h,
+ score/include/rtems/score/watchdog.h:
+ Misc. doxygen fixes.
+
+2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
+
</font> * posix/include/devctl.h: Move mal-placed @file.
2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
<font color='#006600'>diff -u rtems/cpukit/ChangeLog:1.2346.2.5 rtems/cpukit/ChangeLog:1.2346.2.6
--- rtems/cpukit/ChangeLog:1.2346.2.5 Sat Jun 12 00:52:35 2010
+++ rtems/cpukit/ChangeLog Sat Jun 12 00:56:32 2010
</font><font color='#997700'>@@ -1,5 +1,12 @@
</font> 2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
<font color='#000088'>+ * score/include/rtems/score/timestamp.h,
+ score/include/rtems/score/timestamp64.h,
+ score/include/rtems/score/watchdog.h:
+ Misc. doxygen fixes.
+
+2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
+
</font> * posix/include/devctl.h: Move mal-placed @file.
2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
<font color='#006600'>diff -u rtems/cpukit/score/include/rtems/score/timestamp.h:1.3 rtems/cpukit/score/include/rtems/score/timestamp.h:1.4
--- rtems/cpukit/score/include/rtems/score/timestamp.h:1.3 Fri Nov 27 23:58:54 2009
+++ rtems/cpukit/score/include/rtems/score/timestamp.h Sat Jun 12 00:56:26 2010
</font><font color='#997700'>@@ -297,8 +297,8 @@
</font> * This routine converts the @a _ticks value to the corresponding
* timestamp format @a _time.
*
<font color='#880000'>- * @param[in] time points to the timestamp format time result
- * @param[in] ticks points to the number of ticks to be filled in
</font><font color='#000088'>+ * @param[in] _time points to the timestamp format time result
+ * @param[in] _ticks points to the number of ticks to be filled in
</font> */
#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_From_ticks( _ticks, _time ) \
<font color='#006600'>diff -u rtems/cpukit/score/include/rtems/score/timestamp.h:1.3 rtems/cpukit/score/include/rtems/score/timestamp.h:1.3.2.1
--- rtems/cpukit/score/include/rtems/score/timestamp.h:1.3 Fri Nov 27 23:58:54 2009
+++ rtems/cpukit/score/include/rtems/score/timestamp.h Sat Jun 12 00:56:33 2010
</font><font color='#997700'>@@ -297,8 +297,8 @@
</font> * This routine converts the @a _ticks value to the corresponding
* timestamp format @a _time.
*
<font color='#880000'>- * @param[in] time points to the timestamp format time result
- * @param[in] ticks points to the number of ticks to be filled in
</font><font color='#000088'>+ * @param[in] _time points to the timestamp format time result
+ * @param[in] _ticks points to the number of ticks to be filled in
</font> */
#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_From_ticks( _ticks, _time ) \
<font color='#006600'>diff -u rtems/cpukit/score/include/rtems/score/timestamp64.h:1.2 rtems/cpukit/score/include/rtems/score/timestamp64.h:1.3
--- rtems/cpukit/score/include/rtems/score/timestamp64.h:1.2 Fri Nov 27 23:58:54 2009
+++ rtems/cpukit/score/include/rtems/score/timestamp64.h Sat Jun 12 00:56:26 2010
</font><font color='#997700'>@@ -221,7 +221,7 @@
</font> * @return This method returns the number of ticks computed.
*/
uint32_t _Timestamp64_To_ticks(
<font color='#880000'>- const Timestamp64_Control *time
</font><font color='#000088'>+ const Timestamp64_Control *_time
</font> );
/** @brief Convert Ticks to Timestamp
<font color='#997700'>@@ -229,8 +229,8 @@
</font> * This routine converts the @a _ticks value to the corresponding
* timestamp format @a _time.
*
<font color='#880000'>- * @param[in] time points to the timestamp format time result
- * @param[in] ticks points to the number of ticks to be filled in
</font><font color='#000088'>+ * @param[in] _time points to the timestamp format time result
+ * @param[in] _ticks points to the number of ticks to be filled in
</font> */
void _Timestamp64_From_ticks(
uint32_t _ticks,
<font color='#006600'>diff -u rtems/cpukit/score/include/rtems/score/timestamp64.h:1.2 rtems/cpukit/score/include/rtems/score/timestamp64.h:1.2.2.1
--- rtems/cpukit/score/include/rtems/score/timestamp64.h:1.2 Fri Nov 27 23:58:54 2009
+++ rtems/cpukit/score/include/rtems/score/timestamp64.h Sat Jun 12 00:56:32 2010
</font><font color='#997700'>@@ -221,7 +221,7 @@
</font> * @return This method returns the number of ticks computed.
*/
uint32_t _Timestamp64_To_ticks(
<font color='#880000'>- const Timestamp64_Control *time
</font><font color='#000088'>+ const Timestamp64_Control *_time
</font> );
/** @brief Convert Ticks to Timestamp
<font color='#997700'>@@ -229,8 +229,8 @@
</font> * This routine converts the @a _ticks value to the corresponding
* timestamp format @a _time.
*
<font color='#880000'>- * @param[in] time points to the timestamp format time result
- * @param[in] ticks points to the number of ticks to be filled in
</font><font color='#000088'>+ * @param[in] _time points to the timestamp format time result
+ * @param[in] _ticks points to the number of ticks to be filled in
</font> */
void _Timestamp64_From_ticks(
uint32_t _ticks,
<font color='#006600'>diff -u rtems/cpukit/score/include/rtems/score/watchdog.h:1.29 rtems/cpukit/score/include/rtems/score/watchdog.h:1.30
--- rtems/cpukit/score/include/rtems/score/watchdog.h:1.29 Fri Nov 27 23:58:54 2009
+++ rtems/cpukit/score/include/rtems/score/watchdog.h Sat Jun 12 00:56:26 2010
</font><font color='#997700'>@@ -226,7 +226,7 @@
</font> * @a direction for @a units_arg ticks.
*
* @param[in] header is the watchdog chain to adjust
<font color='#880000'>- * @param[in] units is the number of units to adjust @a header
</font><font color='#000088'>+ * @param[in] units_arg is the number of units to adjust @a header
</font> * @param[in] to_fire is a pointer to an initialized Chain_Control to which
* all watchdog instances that are to be fired will be placed.
*
<font color='#997700'>@@ -291,7 +291,7 @@
</font> *
* @param[in] name is a string to prefix the line with. If NULL,
* nothing is printed.
<font color='#880000'>- * @param[in] watch is the watchdog chain to be printed.
</font><font color='#000088'>+ * @param[in] header is the watchdog chain to be printed.
</font> *
* @note This is a debug routine. It uses printk() and prudence should
* exercised when using it. It also disables interrupts so the
<font color='#006600'>diff -u rtems/cpukit/score/include/rtems/score/watchdog.h:1.29 rtems/cpukit/score/include/rtems/score/watchdog.h:1.29.2.1
--- rtems/cpukit/score/include/rtems/score/watchdog.h:1.29 Fri Nov 27 23:58:54 2009
+++ rtems/cpukit/score/include/rtems/score/watchdog.h Sat Jun 12 00:56:32 2010
</font><font color='#997700'>@@ -226,7 +226,7 @@
</font> * @a direction for @a units_arg ticks.
*
* @param[in] header is the watchdog chain to adjust
<font color='#880000'>- * @param[in] units is the number of units to adjust @a header
</font><font color='#000088'>+ * @param[in] units_arg is the number of units to adjust @a header
</font> * @param[in] to_fire is a pointer to an initialized Chain_Control to which
* all watchdog instances that are to be fired will be placed.
*
<font color='#997700'>@@ -291,7 +291,7 @@
</font> *
* @param[in] name is a string to prefix the line with. If NULL,
* nothing is printed.
<font color='#880000'>- * @param[in] watch is the watchdog chain to be printed.
</font><font color='#000088'>+ * @param[in] header is the watchdog chain to be printed.
</font> *
* @note This is a debug routine. It uses printk() and prudence should
* exercised when using it. It also disables interrupts so the
</pre>
<p> </p>
<a name='cs4'></a>
<table border='0' cellspacing='0' cellpadding='5' width='100%' bgcolor='#eeeeee'>
<tr><td colspan='3' bgcolor='#dddddd'>
<font color='#bb2222'><strong>ralf</strong></font>
</td></tr>
<tr><td colspan='3' bgcolor='#dddddd'><pre>Update.
</pre></td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/Doxyfile.in.diff?r1=text&tr1=1.3&r2=text&tr2=1.4&diff_format=h">M</a></td><td width='1%'>1.4</td><td width='100%'>cpukit/Doxyfile.in</td></tr>
</table>
<pre>
<font color='#006600'>diff -u rtems/cpukit/Doxyfile.in:1.3 rtems/cpukit/Doxyfile.in:1.4
--- rtems/cpukit/Doxyfile.in:1.3 Fri May 15 07:52:11 2009
+++ rtems/cpukit/Doxyfile.in Sat Jun 12 01:08:39 2010
</font><font color='#997700'>@@ -1,4 +1,4 @@
</font><font color='#880000'>-# Doxyfile 1.3.4
</font><font color='#000088'>+# Doxyfile 1.6.2-20100208
</font>
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
<font color='#997700'>@@ -14,432 +14,670 @@
</font> # Project related configuration options
#---------------------------------------------------------------------------
<font color='#880000'>-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
</font> # by quotes) that should identify the project.
PROJECT_NAME = "RTEMS CPU Kit with SuperCore"
<font color='#880000'>-# The PROJECT_NUMBER tag can be used to enter a project or revision number.<span style="background-color: #FF0000"> </span>
-# This could be handy for archiving the generated documentation or<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
</font> # if some version control system is used.
PROJECT_NUMBER = @PACKAGE_VERSION@
<font color='#880000'>-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)<span style="background-color: #FF0000"> </span>
-# base path where the generated documentation will be put.<span style="background-color: #FF0000"> </span>
-# If a relative path is entered, it will be relative to the location<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
</font> # where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = cpukit_doxy
<font color='#880000'>-# The OUTPUT_LANGUAGE tag is used to specify the language in which all<span style="background-color: #FF0000"> </span>
-# documentation generated by doxygen is written. Doxygen will use this<span style="background-color: #FF0000"> </span>
-# information to generate all constant output in the proper language.<span style="background-color: #FF0000"> </span>
-# The default language is English, other supported languages are:<span style="background-color: #FF0000"> </span>
-# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,<span style="background-color: #FF0000"> </span>
-# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en<span style="background-color: #FF0000"> </span>
-# (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,<span style="background-color: #FF0000"> </span>
-# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
</font><font color='#000088'>+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
</font>
OUTPUT_LANGUAGE = English
<font color='#880000'>-# This tag can be used to specify the encoding used in the generated output.<span style="background-color: #FF0000"> </span>
-# The encoding is not always determined by the language that is chosen,<span style="background-color: #FF0000"> </span>
-# but also whether or not the output is meant for Windows or non-Windows users.<span style="background-color: #FF0000"> </span>
-# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES<span style="background-color: #FF0000"> </span>
-# forces the Windows encoding (this is the default for the Windows binary),<span style="background-color: #FF0000"> </span>
-# whereas setting the tag to NO uses a Unix-style encoding (the default for<span style="background-color: #FF0000"> </span>
-# all platforms other than Windows).
-
-USE_WINDOWS_ENCODING = NO
-
-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will<span style="background-color: #FF0000"> </span>
-# include brief member descriptions after the members that are listed in<span style="background-color: #FF0000"> </span>
-# the file and class documentation (similar to JavaDoc).<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
</font> # Set to NO to disable this.
BRIEF_MEMBER_DESC = YES
<font color='#880000'>-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend<span style="background-color: #FF0000"> </span>
-# the brief description of a member or function before the detailed description.<span style="background-color: #FF0000"> </span>
-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
</font> # brief descriptions will be completely suppressed.
REPEAT_BRIEF = YES
<font color='#880000'>-# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then<span style="background-color: #FF0000"> </span>
-# Doxygen will generate a detailed section even if there is only a brief<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
</font> # description.
ALWAYS_DETAILED_SEC = NO
<font color='#880000'>-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited<span style="background-color: #FF0000"> </span>
-# members of a class in the documentation of that class as if those members were<span style="background-color: #FF0000"> </span>
-# ordinary class members. Constructors, destructors and assignment operators of<span style="background-color: #FF0000"> </span>
-# the base classes will not be shown.
</font><font color='#000088'>+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
</font>
INLINE_INHERITED_MEMB = NO
<font color='#880000'>-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full<span style="background-color: #FF0000"> </span>
-# path before files name in the file list and in the header files. If set<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
</font> # to NO the shortest path that makes the file name unique will be used.
<font color='#880000'>-FULL_PATH_NAMES = NO
</font><font color='#000088'>+FULL_PATH_NAMES = YES
</font>
<font color='#880000'>-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag<span style="background-color: #FF0000"> </span>
-# can be used to strip a user-defined part of the path. Stripping is<span style="background-color: #FF0000"> </span>
-# only done if one of the specified strings matches the left-hand part of<span style="background-color: #FF0000"> </span>
-# the path. It is allowed to use relative paths in the argument list.
</font><font color='#000088'>+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH = ../lib/include
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
</font>
<font color='#880000'>-STRIP_FROM_PATH =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+STRIP_FROM_INC_PATH =
</font>
<font color='#880000'>-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter<span style="background-color: #FF0000"> </span>
-# (but less readable) file names. This can be useful is your file systems<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
</font> # doesn't support long names like on DOS, Mac, or CD-ROM.
SHORT_NAMES = NO
<font color='#880000'>-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen<span style="background-color: #FF0000"> </span>
-# will interpret the first line (until the first dot) of a JavaDoc-style<span style="background-color: #FF0000"> </span>
-# comment as the brief description. If set to NO, the JavaDoc<span style="background-color: #FF0000"> </span>
-# comments will behave just like the Qt-style comments (thus requiring an<span style="background-color: #FF0000"> </span>
-# explict @brief command for a brief description.
</font><font color='#000088'>+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
</font>
JAVADOC_AUTOBRIEF = YES
<font color='#880000'>-# If the QT_AUTOBRIEF tag is set to YES then Doxygen will<span style="background-color: #FF0000"> </span>
-# interpret the first line (until the first dot) of a Qt-style<span style="background-color: #FF0000"> </span>
-# comment as the brief description. If set to NO, the comments<span style="background-color: #FF0000"> </span>
-# will behave just like regular Qt-style comments (thus requiring<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
</font> # an explicit \brief command for a brief description.)
QT_AUTOBRIEF = YES
<font color='#880000'>-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen<span style="background-color: #FF0000"> </span>
-# treat a multi-line C++ special comment block (i.e. a block of //! or ///<span style="background-color: #FF0000"> </span>
-# comments) as a brief description. This used to be the default behaviour.<span style="background-color: #FF0000"> </span>
-# The new default is to treat a multi-line C++ comment block as a detailed<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
</font> # description. Set this tag to YES if you prefer the old behaviour instead.
MULTILINE_CPP_IS_BRIEF = NO
<font color='#880000'>-# If the DETAILS_AT_TOP tag is set to YES then Doxygen<span style="background-color: #FF0000"> </span>
-# will output the detailed description near the top, like JavaDoc.
-# If set to NO, the detailed description appears after the member<span style="background-color: #FF0000"> </span>
-# documentation.
-
-DETAILS_AT_TOP = NO
-
-# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented<span style="background-color: #FF0000"> </span>
-# member inherits the documentation from any documented member that it<span style="background-color: #FF0000"> </span>
-# reimplements.
</font><font color='#000088'>+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
</font>
INHERIT_DOCS = YES
<font color='#880000'>-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC<span style="background-color: #FF0000"> </span>
-# tag is set to YES, then doxygen will reuse the documentation of the first<span style="background-color: #FF0000"> </span>
-# member in the group (if any) for the other members of the group. By default<span style="background-color: #FF0000"> </span>
-# all members of a group must be documented explicitly.
</font><font color='#000088'>+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
</font>
<font color='#880000'>-DISTRIBUTE_GROUP_DOC = NO
</font><font color='#000088'>+SEPARATE_MEMBER_PAGES = NO
</font>
<font color='#880000'>-# The TAB_SIZE tag can be used to set the number of spaces in a tab.<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
</font> # Doxygen uses this value to replace tabs by spaces in code fragments.
TAB_SIZE = 8
<font color='#880000'>-# This tag can be used to specify a number of aliases that acts<span style="background-color: #FF0000"> </span>
-# as commands in the documentation. An alias has the form "name=value".<span style="background-color: #FF0000"> </span>
-# For example adding "sideeffect=\par Side Effects:\n" will allow you to<span style="background-color: #FF0000"> </span>
-# put the command \sideeffect (or @sideeffect) in the documentation, which<span style="background-color: #FF0000"> </span>
-# will result in a user-defined paragraph with heading "Side Effects:".<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
</font> # You can put \n's in the value part of an alias to insert newlines.
<font color='#880000'>-ALIASES =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+ALIASES =
</font>
<font color='#880000'>-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources<span style="background-color: #FF0000"> </span>
-# only. Doxygen will then generate output that is more tailored for C.<span style="background-color: #FF0000"> </span>
-# For instance, some of the names that are used will be different. The list<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
</font> # of all members will be omitted, etc.
OPTIMIZE_OUTPUT_FOR_C = YES
<font color='#880000'>-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources<span style="background-color: #FF0000"> </span>
-# only. Doxygen will then generate output that is more tailored for Java.<span style="background-color: #FF0000"> </span>
-# For instance, namespaces will be presented as packages, qualified scopes<span style="background-color: #FF0000"> </span>
-# will look different, etc.
</font><font color='#000088'>+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
</font>
OPTIMIZE_OUTPUT_JAVA = NO
<font color='#880000'>-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of<span style="background-color: #FF0000"> </span>
-# the same type (for instance a group of public functions) to be put as a<span style="background-color: #FF0000"> </span>
-# subgroup of that type (e.g. under the Public Functions section). Set it to<span style="background-color: #FF0000"> </span>
-# NO to prevent subgrouping. Alternatively, this can be done per class using<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it parses.
+# With this tag you can assign which parser to use for a given extension.
+# Doxygen has a built-in mapping, but you can override or extend it using this tag.
+# The format is ext=language, where ext is a file extension, and language is one of
+# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
+# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
+# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
+# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+
+EXTENSION_MAPPING =
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use public
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# and setter methods for a property. Setting this option to YES (the default)
+# will make doxygen to replace the get and set methods by a property in the
+# documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
</font> # the \nosubgrouping command.
SUBGROUPING = YES
<font color='#000088'>+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penality.
+# If the system has enough physical memory increasing the cache will improve the
+# performance by keeping more symbols in memory. Note that the value works on
+# a logarithmic scale so increasing the size by one will rougly double the
+# memory usage. The cache size is given by this formula:
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols
+
+SYMBOL_CACHE_SIZE = 0
+
</font> #---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
<font color='#880000'>-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in<span style="background-color: #FF0000"> </span>
-# documentation are documented, even if no documentation was available.<span style="background-color: #FF0000"> </span>
-# Private class members and static file members will be hidden unless<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
</font> # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
EXTRACT_ALL = NO
<font color='#880000'>-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
</font> # will be included in the documentation.
EXTRACT_PRIVATE = NO
<font color='#880000'>-# If the EXTRACT_STATIC tag is set to YES all static members of a file<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the EXTRACT_STATIC tag is set to YES all static members of a file
</font> # will be included in the documentation.
EXTRACT_STATIC = NO
<font color='#880000'>-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)<span style="background-color: #FF0000"> </span>
-# defined locally in source files will be included in the documentation.<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
</font> # If set to NO only classes defined in header files are included.
EXTRACT_LOCAL_CLASSES = YES
<font color='#880000'>-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all<span style="background-color: #FF0000"> </span>
-# undocumented members of documented classes, files or namespaces.<span style="background-color: #FF0000"> </span>
-# If set to NO (the default) these members will be included in the<span style="background-color: #FF0000"> </span>
-# various overviews, but no documentation section is generated.<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespace are hidden.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
</font> # This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_MEMBERS = NO
<font color='#880000'>-# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all<span style="background-color: #FF0000"> </span>
-# undocumented classes that are normally visible in the class hierarchy.<span style="background-color: #FF0000"> </span>
-# If set to NO (the default) these classes will be included in the various<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
</font> # overviews. This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_CLASSES = NO
<font color='#880000'>-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all<span style="background-color: #FF0000"> </span>
-# friend (class|struct|union) declarations.<span style="background-color: #FF0000"> </span>
-# If set to NO (the default) these declarations will be included in the<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
</font> # documentation.
HIDE_FRIEND_COMPOUNDS = NO
<font color='#880000'>-# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any<span style="background-color: #FF0000"> </span>
-# documentation blocks found inside the body of a function.<span style="background-color: #FF0000"> </span>
-# If set to NO (the default) these blocks will be appended to the<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
</font> # function's detailed documentation block.
HIDE_IN_BODY_DOCS = NO
<font color='#880000'>-# The INTERNAL_DOCS tag determines if documentation<span style="background-color: #FF0000"> </span>
-# that is typed after a \internal command is included. If the tag is set<span style="background-color: #FF0000"> </span>
-# to NO (the default) then the documentation will be excluded.<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
</font> # Set it to YES to include the internal documentation.
INTERNAL_DOCS = NO
<font color='#880000'>-# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate<span style="background-color: #FF0000"> </span>
-# file names in lower-case letters. If set to YES upper-case letters are also<span style="background-color: #FF0000"> </span>
-# allowed. This is useful if you have classes or files whose names only differ<span style="background-color: #FF0000"> </span>
-# in case and if your file system supports case sensitive file names. Windows<span style="background-color: #FF0000"> </span>
-# users are advised to set this option to NO.
</font><font color='#000088'>+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
</font>
CASE_SENSE_NAMES = YES
<font color='#880000'>-# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen<span style="background-color: #FF0000"> </span>
-# will show members with their full class and namespace scopes in the<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
</font> # documentation. If set to YES the scope will be hidden.
HIDE_SCOPE_NAMES = NO
<font color='#880000'>-# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen<span style="background-color: #FF0000"> </span>
-# will put a list of the files that are included by a file in the documentation<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
</font> # of that file.
SHOW_INCLUDE_FILES = YES
<font color='#880000'>-# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
+# will list include files with double quotes in the documentation
+# rather than with sharp brackets.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
</font> # is inserted in the documentation for inline members.
INLINE_INFO = YES
<font color='#880000'>-# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen<span style="background-color: #FF0000"> </span>
-# will sort the (detailed) documentation of file and class members<span style="background-color: #FF0000"> </span>
-# alphabetically by member name. If set to NO the members will appear in<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
</font> # declaration order.
SORT_MEMBER_DOCS = YES
<font color='#880000'>-# The GENERATE_TODOLIST tag can be used to enable (YES) or<span style="background-color: #FF0000"> </span>
-# disable (NO) the todo list. This list is created by putting \todo<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
</font> # commands in the documentation.
GENERATE_TODOLIST = YES
<font color='#880000'>-# The GENERATE_TESTLIST tag can be used to enable (YES) or<span style="background-color: #FF0000"> </span>
-# disable (NO) the test list. This list is created by putting \test<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
</font> # commands in the documentation.
GENERATE_TESTLIST = YES
<font color='#880000'>-# The GENERATE_BUGLIST tag can be used to enable (YES) or<span style="background-color: #FF0000"> </span>
-# disable (NO) the bug list. This list is created by putting \bug<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
</font> # commands in the documentation.
GENERATE_BUGLIST = YES
<font color='#880000'>-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or<span style="background-color: #FF0000"> </span>
-# disable (NO) the deprecated list. This list is created by putting<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
</font> # \deprecated commands in the documentation.
GENERATE_DEPRECATEDLIST= YES
<font color='#880000'>-# The ENABLED_SECTIONS tag can be used to enable conditional<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The ENABLED_SECTIONS tag can be used to enable conditional
</font> # documentation sections, marked by \if sectionname ... \endif.
<font color='#880000'>-ENABLED_SECTIONS =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+ENABLED_SECTIONS =
</font>
<font color='#880000'>-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines<span style="background-color: #FF0000"> </span>
-# the initial value of a variable or define consists of for it to appear in<span style="background-color: #FF0000"> </span>
-# the documentation. If the initializer consists of more lines than specified<span style="background-color: #FF0000"> </span>
-# here it will be hidden. Use a value of 0 to hide initializers completely.<span style="background-color: #FF0000"> </span>
-# The appearance of the initializer of individual variables and defines in the<span style="background-color: #FF0000"> </span>
-# documentation can be controlled using \showinitializer or \hideinitializer<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
</font> # command in the documentation regardless of this setting.
MAX_INITIALIZER_LINES = 30
<font color='#880000'>-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated<span style="background-color: #FF0000"> </span>
-# at the bottom of the documentation of classes and structs. If set to YES the<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
</font> # list will mention the files that were used to generate the documentation.
SHOW_USED_FILES = YES
<font color='#000088'>+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page.
+# This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
+# doxygen. The layout file controls the global structure of the generated output files
+# in an output format independent way. The create the layout file that represents
+# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
+# file name after the option, if omitted DoxygenLayout.xml will be used as the name
+# of the layout file.
+
+LAYOUT_FILE =
+
</font> #---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
<font color='#880000'>-# The QUIET tag can be used to turn on/off the messages that are generated<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The QUIET tag can be used to turn on/off the messages that are generated
</font> # by doxygen. Possible values are YES and NO. If left blank NO is used.
QUIET = NO
<font color='#880000'>-# The WARNINGS tag can be used to turn on/off the warning messages that are<span style="background-color: #FF0000"> </span>
-# generated by doxygen. Possible values are YES and NO. If left blank<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
</font> # NO is used.
WARNINGS = YES
<font color='#880000'>-# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings<span style="background-color: #FF0000"> </span>
-# for undocumented members. If EXTRACT_ALL is set to YES then this flag will<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
</font> # automatically be disabled.
WARN_IF_UNDOCUMENTED = YES
<font color='#880000'>-# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for<span style="background-color: #FF0000"> </span>
-# potential errors in the documentation, such as not documenting some<span style="background-color: #FF0000"> </span>
-# parameters in a documented function, or documenting parameters that<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
</font> # don't exist or using markup commands wrongly.
WARN_IF_DOC_ERROR = YES
<font color='#880000'>-# The WARN_FORMAT tag determines the format of the warning messages that<span style="background-color: #FF0000"> </span>
-# doxygen can produce. The string should contain the $file, $line, and $text<span style="background-color: #FF0000"> </span>
-# tags, which will be replaced by the file and line number from which the<span style="background-color: #FF0000"> </span>
-# warning originated and the warning text.
</font><font color='#000088'>+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
</font>
WARN_FORMAT = "$file:$line: $text"
<font color='#880000'>-# The WARN_LOGFILE tag can be used to specify a file to which warning<span style="background-color: #FF0000"> </span>
-# and error messages should be written. If left blank the output is written<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
</font> # to stderr.
<font color='#880000'>-WARN_LOGFILE =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+WARN_LOGFILE =
</font>
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
<font color='#880000'>-# The INPUT tag can be used to specify the files and/or directories that contain<span style="background-color: #FF0000"> </span>
-# documented source files. You may enter file names like "myfile.cpp" or<span style="background-color: #FF0000"> </span>
-# directories like "/usr/src/myproject". Separate the files or directories<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
</font> # with spaces.
INPUT = ../lib/include
<font color='#880000'>-# If the value of the INPUT tag contains directories, you can use the<span style="background-color: #FF0000"> </span>
-# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp<span style="background-color: #FF0000"> </span>
-# and *.h) to filter out the source-files in the directories. If left<span style="background-color: #FF0000"> </span>
-# blank the following patterns are tested:<span style="background-color: #FF0000"> </span>
-# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp<span style="background-color: #FF0000"> </span>
-# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
</font><font color='#000088'>+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+
+INPUT_ENCODING = UTF-8
+
+# 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
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
</font>
<font color='#880000'>-FILE_PATTERNS = *.h *.inl
</font><font color='#000088'>+FILE_PATTERNS = *.h \
+ *.inl
</font>
<font color='#880000'>-# The RECURSIVE tag can be used to turn specify whether or not subdirectories<span style="background-color: #FF0000"> </span>
-# should be searched for input files as well. Possible values are YES and NO.<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# 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.
</font> # If left blank NO is used.
RECURSIVE = YES
<font color='#880000'>-# The EXCLUDE tag can be used to specify files and/or directories that should<span style="background-color: #FF0000"> </span>
-# excluded from the INPUT source files. This way you can easily exclude a<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
</font> # subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE = score/mainpage.h
<font color='#880000'>-# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories<span style="background-color: #FF0000"> </span>
-# that are symbolic links (a Unix filesystem feature) are excluded from the input.
</font><font color='#000088'>+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
</font>
EXCLUDE_SYMLINKS = NO
<font color='#880000'>-# If the value of the INPUT tag contains directories, you can use the<span style="background-color: #FF0000"> </span>
-# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude<span style="background-color: #FF0000"> </span>
-# certain files from those directories.
</font><font color='#000088'>+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
</font>
<font color='#880000'>-EXCLUDE_PATTERNS =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+EXCLUDE_SYMBOLS =
</font>
<font color='#880000'>-# The EXAMPLE_PATH tag can be used to specify one or more files or<span style="background-color: #FF0000"> </span>
-# directories that contain example code fragments that are included (see<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
</font> # the \include command).
<font color='#880000'>-EXAMPLE_PATH =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+EXAMPLE_PATH =
</font>
<font color='#880000'>-# If the value of the EXAMPLE_PATH tag contains directories, you can use the<span style="background-color: #FF0000"> </span>
-# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp<span style="background-color: #FF0000"> </span>
-# and *.h) to filter out the source-files in the directories. If left<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# 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
</font> # blank all files are included.
<font color='#880000'>-EXAMPLE_PATTERNS =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+EXAMPLE_PATTERNS =
</font>
<font color='#880000'>-# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be<span style="background-color: #FF0000"> </span>
-# searched for input files to be used with the \include or \dontinclude<span style="background-color: #FF0000"> </span>
-# commands irrespective of the value of the RECURSIVE tag.<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# 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.
</font> # Possible values are YES and NO. If left blank NO is used.
EXAMPLE_RECURSIVE = NO
<font color='#880000'>-# The IMAGE_PATH tag can be used to specify one or more files or<span style="background-color: #FF0000"> </span>
-# directories that contain image that are included in the documentation (see<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# 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
</font> # the \image command).
<font color='#880000'>-IMAGE_PATH =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+IMAGE_PATH =
</font>
<font color='#880000'>-# The INPUT_FILTER tag can be used to specify a program that doxygen should<span style="background-color: #FF0000"> </span>
-# invoke to filter for each input file. Doxygen will invoke the filter program<span style="background-color: #FF0000"> </span>
-# by executing (via popen()) the command <filter> <input-file>, where <filter><span style="background-color: #FF0000"> </span>
-# is the value of the INPUT_FILTER tag, and <input-file> is the name of an<span style="background-color: #FF0000"> </span>
-# input file. Doxygen will then use the output that the filter program writes<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
</font> # to standard output.
<font color='#000088'>+# If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER = @top_srcdir@/doxy-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
+# filter if there is a match.
+# The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
+# is applied to all files.
</font>
<font color='#880000'>-INPUT_FILTER =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+FILTER_PATTERNS =
</font>
<font color='#880000'>-# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using<span style="background-color: #FF0000"> </span>
-# INPUT_FILTER) will be used to filter the input files when producing source<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# 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
</font> # files to browse (i.e. when SOURCE_BROWSER is set to YES).
FILTER_SOURCE_FILES = NO
<font color='#997700'>@@ -448,36 +686,54 @@
</font> # configuration options related to source browsing
#---------------------------------------------------------------------------
<font color='#880000'>-# If the SOURCE_BROWSER tag is set to YES then a list of source files will<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
</font> # be generated. Documented entities will be cross-referenced with these sources.
<font color='#000088'>+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
</font>
SOURCE_BROWSER = NO
<font color='#880000'>-# Setting the INLINE_SOURCES tag to YES will include the body<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# Setting the INLINE_SOURCES tag to YES will include the body
</font> # of functions and classes directly in the documentation.
INLINE_SOURCES = NO
<font color='#880000'>-# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct<span style="background-color: #FF0000"> </span>
-# doxygen to hide any special comment blocks from generated source code<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
</font> # fragments. Normal C and C++ comments will always remain visible.
STRIP_CODE_COMMENTS = YES
<font color='#880000'>-# If the REFERENCED_BY_RELATION tag is set to YES (the default)<span style="background-color: #FF0000"> </span>
-# then for each documented function all documented<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
</font> # functions referencing it will be listed.
REFERENCED_BY_RELATION = YES
<font color='#880000'>-# If the REFERENCES_RELATION tag is set to YES (the default)<span style="background-color: #FF0000"> </span>
-# then for each documented function all documented entities<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the REFERENCES_RELATION tag is set to YES
+# then for each documented function all documented entities
</font> # called/used by that function will be listed.
REFERENCES_RELATION = YES
<font color='#880000'>-# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen<span style="background-color: #FF0000"> </span>
-# will generate a verbatim copy of the header file for each class for<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code.
+# Otherwise they will link to the documentation.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
</font> # which an include is specified. Set to NO to disable this.
VERBATIM_HEADERS = YES
<font color='#997700'>@@ -486,277 +742,429 @@
</font> # configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
<font color='#880000'>-# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index<span style="background-color: #FF0000"> </span>
-# of all compounds will be generated. Enable this if the project<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
</font> # contains a lot of classes, structs, unions or interfaces.
ALPHABETICAL_INDEX = NO
<font color='#880000'>-# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then<span style="background-color: #FF0000"> </span>
-# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
</font> # in which this list will be split (can be a number in the range [1..20])
COLS_IN_ALPHA_INDEX = 5
<font color='#880000'>-# In case all classes in a project start with a common prefix, all<span style="background-color: #FF0000"> </span>
-# classes will be put under the same header in the alphabetical index.<span style="background-color: #FF0000"> </span>
-# The IGNORE_PREFIX tag can be used to specify one or more prefixes that<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
</font> # should be ignored while generating the index headers.
<font color='#880000'>-IGNORE_PREFIX =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+IGNORE_PREFIX =
</font>
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
<font color='#880000'>-# If the GENERATE_HTML tag is set to YES (the default) Doxygen will<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
</font> # generate HTML output.
GENERATE_HTML = YES
<font color='#880000'>-# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.<span style="background-color: #FF0000"> </span>
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
</font> # put in front of it. If left blank `html' will be used as the default path.
HTML_OUTPUT = html
<font color='#880000'>-# The HTML_FILE_EXTENSION tag can be used to specify the file extension for<span style="background-color: #FF0000"> </span>
-# each generated HTML page (for example: .htm,.php,.asp). If it is left blank<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
</font> # doxygen will generate files with .html extension.
HTML_FILE_EXTENSION = .html
<font color='#880000'>-# The HTML_HEADER tag can be used to specify a personal HTML header for<span style="background-color: #FF0000"> </span>
-# each generated HTML page. If it is left blank doxygen will generate a<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
</font> # standard header.
<font color='#880000'>-HTML_HEADER =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+HTML_HEADER =
</font>
<font color='#880000'>-# The HTML_FOOTER tag can be used to specify a personal HTML footer for<span style="background-color: #FF0000"> </span>
-# each generated HTML page. If it is left blank doxygen will generate a<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
</font> # standard footer.
<font color='#880000'>-HTML_FOOTER =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+HTML_FOOTER =
+
+# If the HTML_TIMESTAMP tag is set to YES then the generated HTML
+# documentation will contain the timesstamp.
+
+HTML_TIMESTAMP = NO
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET =
</font>
<font color='#880000'>-# The HTML_STYLESHEET tag can be used to specify a user-defined cascading<span style="background-color: #FF0000"> </span>
-# style sheet that is used by each HTML page. It can be used to<span style="background-color: #FF0000"> </span>
-# fine-tune the look of the HTML output. If the tag is left blank doxygen<span style="background-color: #FF0000"> </span>
-# will generate a default style sheet
</font><font color='#000088'>+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting
+# this to NO can help when comparing the output of multiple runs.
</font>
<font color='#880000'>-HTML_STYLESHEET =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+HTML_TIMESTAMP = NO
</font>
<font color='#880000'>-# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,<span style="background-color: #FF0000"> </span>
-# files or namespaces will be aligned in HTML using tables. If set to<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
</font> # NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES
<font color='#880000'>-# If the GENERATE_HTMLHELP tag is set to YES, additional index files<span style="background-color: #FF0000"> </span>
-# will be generated that can be used as input for tools like the<span style="background-color: #FF0000"> </span>
-# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded. For this to work a browser that supports
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
+
+GENERATE_DOCSET = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# feed. A documentation feed provides an umbrella under which multiple
+# documentation sets from a single provider (such as a company or product suite)
+# can be grouped.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
+# should uniquely identify the documentation set bundle. This should be a
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
</font> # of the generated HTML documentation.
GENERATE_HTMLHELP = NO
<font color='#880000'>-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can<span style="background-color: #FF0000"> </span>
-# be used to specify the file name of the resulting .chm file. You<span style="background-color: #FF0000"> </span>
-# can add a path in front of the file if the result should not be<span style="background-color: #FF0000"> </span>
-# written to the html output dir.
-
-CHM_FILE =<span style="background-color: #FF0000"> </span>
-
-# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can<span style="background-color: #FF0000"> </span>
-# be used to specify the location (absolute path including file name) of<span style="background-color: #FF0000"> </span>
-# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
</font> # the HTML help compiler on the generated index.hhp.
<font color='#880000'>-HHC_LOCATION =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+HHC_LOCATION =
</font>
<font color='#880000'>-# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag<span style="background-color: #FF0000"> </span>
-# controls if a separate .chi index file is generated (YES) or that<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
</font> # it should be included in the master .chm file (NO).
GENERATE_CHI = NO
<font color='#880000'>-# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag<span style="background-color: #FF0000"> </span>
-# controls whether a binary table of contents is generated (YES) or a<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
</font> # normal table of contents (NO) in the .chm file.
BINARY_TOC = NO
<font color='#880000'>-# The TOC_EXPAND flag can be set to YES to add extra items for group members<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The TOC_EXPAND flag can be set to YES to add extra items for group members
</font> # to the contents of the HTML help documentation and to the tree view.
TOC_EXPAND = NO
<font color='#880000'>-# The DISABLE_INDEX tag can be used to turn on/off the condensed index at<span style="background-color: #FF0000"> </span>
-# top of each HTML page. The value NO (the default) enables the index and<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
+# are set, an additional index file will be generated that can be used as input for
+# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
+# HTML documentation.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
+# be used to specify the file name of the resulting .qch file.
+# The path specified is relative to the HTML output folder.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#namespace
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
+# For more information please see
+# http://doc.trolltech.com/qthelpproject.html#custom-filters
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
+
+QHP_SECT_FILTER_ATTRS =
+
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
+# be used to specify the location of Qt's qhelpgenerator.
+# If non-empty doxygen will try to run qhelpgenerator on the generated
+# .qhp file.
+
+QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+# will be generated, which together with the HTML files, form an Eclipse help
+# plugin. To install this plugin and make it available under the help contents
+# menu in Eclipse, the contents of the directory containing the HTML and XML
+# files needs to be copied into the plugins directory of eclipse. The name of
+# the directory within the plugins directory should be the same as
+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have
+# this name.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
</font> # the value YES disables it.
DISABLE_INDEX = NO
<font color='#880000'>-# This tag can be used to set the number of enum values (range [1..20])<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# This tag can be used to set the number of enum values (range [1..20])
</font> # that doxygen will group on one line in the generated HTML documentation.
ENUM_VALUES_PER_LINE = 4
<font color='#880000'>-# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
-# generated containing a tree-like index structure (just like the one that<span style="background-color: #FF0000"> </span>
-# is generated for HTML Help). For this to work a browser that supports<span style="background-color: #FF0000"> </span>
-# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,<span style="background-color: #FF0000"> </span>
-# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are<span style="background-color: #FF0000"> </span>
-# probably better off using the HTML help feature.
</font><font color='#000088'>+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to YES, a side panel will be generated
+# containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
+# Windows users are probably better off using the HTML help feature.
</font>
GENERATE_TREEVIEW = NO
<font color='#880000'>-# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be<span style="background-color: #FF0000"> </span>
-# used to set the initial width (in pixels) of the frame in which the tree<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list.
+
+USE_INLINE_TREES = NO
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
</font> # is shown.
TREEVIEW_WIDTH = 250
<font color='#000088'>+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE = 10
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
+# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
+# typically be disabled. For large projects the javascript based search engine
+# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
+
+SEARCHENGINE = NO
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index
+# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup
+# and does not have live searching capabilities.
+
+SERVER_BASED_SEARCH = NO
+
</font> #---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
<font color='#880000'>-# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
</font> # generate Latex output.
GENERATE_LATEX = YES
<font color='#880000'>-# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.<span style="background-color: #FF0000"> </span>
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
</font> # put in front of it. If left blank `latex' will be used as the default path.
LATEX_OUTPUT = latex
<font color='#880000'>-# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
</font> # invoked. If left blank `latex' will be used as the default command name.
<font color='#000088'>+# Note that when enabling USE_PDFLATEX this option is only used for
+# generating bitmaps for formulas in the HTML output, but not in the
+# Makefile that is written to the output directory.
</font>
LATEX_CMD_NAME = latex
<font color='#880000'>-# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to<span style="background-color: #FF0000"> </span>
-# generate index for LaTeX. If left blank `makeindex' will be used as the<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
</font> # default command name.
MAKEINDEX_CMD_NAME = makeindex
<font color='#880000'>-# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact<span style="background-color: #FF0000"> </span>
-# LaTeX documents. This may be useful for small projects and may help to<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
</font> # save some trees in general.
COMPACT_LATEX = NO
<font color='#880000'>-# The PAPER_TYPE tag can be used to set the paper type that is used<span style="background-color: #FF0000"> </span>
-# by the printer. Possible values are: a4, a4wide, letter, legal and<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
</font> # executive. If left blank a4wide will be used.
PAPER_TYPE = a4wide
<font color='#880000'>-# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
</font> # packages that should be included in the LaTeX output.
<font color='#880000'>-EXTRA_PACKAGES =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+EXTRA_PACKAGES =
</font>
<font color='#880000'>-# The LATEX_HEADER tag can be used to specify a personal LaTeX header for<span style="background-color: #FF0000"> </span>
-# the generated latex document. The header should contain everything until<span style="background-color: #FF0000"> </span>
-# the first chapter. If it is left blank doxygen will generate a<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
</font> # standard header. Notice: only use this tag if you know what you are doing!
<font color='#880000'>-LATEX_HEADER =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+LATEX_HEADER =
</font>
<font color='#880000'>-# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated<span style="background-color: #FF0000"> </span>
-# is prepared for conversion to pdf (using ps2pdf). The pdf file will<span style="background-color: #FF0000"> </span>
-# contain links (just like the HTML output) instead of page references<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
</font> # This makes the output suitable for online browsing using a pdf viewer.
PDF_HYPERLINKS = NO
<font color='#880000'>-# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of<span style="background-color: #FF0000"> </span>
-# plain latex in the generated Makefile. Set this option to YES to get a<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
</font> # higher quality PDF documentation.
USE_PDFLATEX = NO
<font color='#880000'>-# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.<span style="background-color: #FF0000"> </span>
-# command to the generated LaTeX files. This will instruct LaTeX to keep<span style="background-color: #FF0000"> </span>
-# running if errors occur, instead of asking the user for help.<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
</font> # This option is also used when generating formulas in HTML.
LATEX_BATCHMODE = NO
<font color='#880000'>-# If LATEX_HIDE_INDICES is set to YES then doxygen will not<span style="background-color: #FF0000"> </span>
-# include the index chapters (such as File Index, Compound Index, etc.)<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
</font> # in the output.
LATEX_HIDE_INDICES = NO
<font color='#000088'>+# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
+
+LATEX_SOURCE_CODE = NO
+
</font> #---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
<font color='#880000'>-# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output<span style="background-color: #FF0000"> </span>
-# The RTF output is optimised for Word 97 and may not look very pretty with<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
</font> # other RTF readers or editors.
GENERATE_RTF = NO
<font color='#880000'>-# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.<span style="background-color: #FF0000"> </span>
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
</font> # put in front of it. If left blank `rtf' will be used as the default path.
RTF_OUTPUT = rtf
<font color='#880000'>-# If the COMPACT_RTF tag is set to YES Doxygen generates more compact<span style="background-color: #FF0000"> </span>
-# RTF documents. This may be useful for small projects and may help to<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
</font> # save some trees in general.
COMPACT_RTF = NO
<font color='#880000'>-# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated<span style="background-color: #FF0000"> </span>
-# will contain hyperlink fields. The RTF file will<span style="background-color: #FF0000"> </span>
-# contain links (just like the HTML output) instead of page references.<span style="background-color: #FF0000"> </span>
-# This makes the output suitable for online browsing using WORD or other<span style="background-color: #FF0000"> </span>
-# programs which support those fields.<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
</font> # Note: wordpad (write) and others do not support links.
RTF_HYPERLINKS = NO
<font color='#880000'>-# Load stylesheet definitions from file. Syntax is similar to doxygen's<span style="background-color: #FF0000"> </span>
-# config file, i.e. a series of assigments. You only have to provide<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
</font> # replacements, missing definitions are set to their default value.
<font color='#880000'>-RTF_STYLESHEET_FILE =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+RTF_STYLESHEET_FILE =
</font>
<font color='#880000'>-# Set optional variables used in the generation of an rtf document.<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# Set optional variables used in the generation of an rtf document.
</font> # Syntax is similar to doxygen's config file.
<font color='#880000'>-RTF_EXTENSIONS_FILE =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+RTF_EXTENSIONS_FILE =
</font>
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
<font color='#880000'>-# If the GENERATE_MAN tag is set to YES (the default) Doxygen will<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
</font> # generate man pages
GENERATE_MAN = NO
<font color='#880000'>-# The MAN_OUTPUT tag is used to specify where the man pages will be put.<span style="background-color: #FF0000"> </span>
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
</font> # put in front of it. If left blank `man' will be used as the default path.
MAN_OUTPUT = man
<font color='#880000'>-# The MAN_EXTENSION tag determines the extension that is added to<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The MAN_EXTENSION tag determines the extension that is added to
</font> # the generated man pages (default is the subroutine's section .3)
MAN_EXTENSION = .3
<font color='#880000'>-# If the MAN_LINKS tag is set to YES and Doxygen generates man output,<span style="background-color: #FF0000"> </span>
-# then it will generate one additional man file for each entity<span style="background-color: #FF0000"> </span>
-# documented in the real man page(s). These additional files<span style="background-color: #FF0000"> </span>
-# only source the real man page, but without them the man command<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
</font> # would be unable to find the correct page. The default is NO.
MAN_LINKS = NO
<font color='#997700'>@@ -765,40 +1173,45 @@
</font> # configuration options related to the XML output
#---------------------------------------------------------------------------
<font color='#880000'>-# If the GENERATE_XML tag is set to YES Doxygen will<span style="background-color: #FF0000"> </span>
-# generate an XML file that captures the structure of<span style="background-color: #FF0000"> </span>
-# the code including all documentation. Note that this<span style="background-color: #FF0000"> </span>
-# feature is still experimental and incomplete at the<span style="background-color: #FF0000"> </span>
-# moment.
</font><font color='#000088'>+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
</font>
GENERATE_XML = NO
<font color='#880000'>-# The XML_OUTPUT tag is used to specify where the XML pages will be put.<span style="background-color: #FF0000"> </span>
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
</font> # put in front of it. If left blank `xml' will be used as the default path.
XML_OUTPUT = xml
<font color='#880000'>-# The XML_SCHEMA tag can be used to specify an XML schema,<span style="background-color: #FF0000"> </span>
-# which can be used by a validating XML parser to check the<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
</font> # syntax of the XML files.
<font color='#880000'>-XML_SCHEMA =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+XML_SCHEMA =
</font>
<font color='#880000'>-# The XML_DTD tag can be used to specify an XML DTD,<span style="background-color: #FF0000"> </span>
-# which can be used by a validating XML parser to check the<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
</font> # syntax of the XML files.
<font color='#880000'>-XML_DTD =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+XML_DTD =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING = YES
</font>
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
<font color='#880000'>-# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will<span style="background-color: #FF0000"> </span>
-# generate an AutoGen Definitions (see autogen.sf.net) file<span style="background-color: #FF0000"> </span>
-# that captures the structure of the code including all<span style="background-color: #FF0000"> </span>
-# documentation. Note that this feature is still experimental<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
</font> # and incomplete at the moment.
GENERATE_AUTOGEN_DEF = NO
<font color='#997700'>@@ -807,284 +1220,342 @@
</font> # configuration options related to the Perl module output
#---------------------------------------------------------------------------
<font color='#880000'>-# If the GENERATE_PERLMOD tag is set to YES Doxygen will<span style="background-color: #FF0000"> </span>
-# generate a Perl module file that captures the structure of<span style="background-color: #FF0000"> </span>
-# the code including all documentation. Note that this<span style="background-color: #FF0000"> </span>
-# feature is still experimental and incomplete at the<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
</font> # moment.
GENERATE_PERLMOD = NO
<font color='#880000'>-# If the PERLMOD_LATEX tag is set to YES Doxygen will generate<span style="background-color: #FF0000"> </span>
-# the necessary Makefile rules, Perl scripts and LaTeX code to be able<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
</font> # to generate PDF and DVI output from the Perl module output.
PERLMOD_LATEX = NO
<font color='#880000'>-# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be<span style="background-color: #FF0000"> </span>
-# nicely formatted so it can be parsed by a human reader. This is useful<span style="background-color: #FF0000"> </span>
-# if you want to understand what is going on. On the other hand, if this<span style="background-color: #FF0000"> </span>
-# tag is set to NO the size of the Perl module output will be much smaller<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader.
+# This is useful
+# if you want to understand what is going on.
+# On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
</font> # and Perl will parse it just the same.
PERLMOD_PRETTY = YES
<font color='#880000'>-# The names of the make variables in the generated doxyrules.make file<span style="background-color: #FF0000"> </span>
-# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.<span style="background-color: #FF0000"> </span>
-# This is useful so different doxyrules.make files included by the same<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
</font> # Makefile don't overwrite each other's variables.
<font color='#880000'>-PERLMOD_MAKEVAR_PREFIX =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+PERLMOD_MAKEVAR_PREFIX =
</font>
#---------------------------------------------------------------------------
<font color='#880000'>-# Configuration options related to the preprocessor<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# Configuration options related to the preprocessor
</font> #---------------------------------------------------------------------------
<font color='#880000'>-# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will<span style="background-color: #FF0000"> </span>
-# evaluate all C-preprocessor directives found in the sources and include<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
</font> # files.
ENABLE_PREPROCESSING = YES
<font color='#880000'>-# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro<span style="background-color: #FF0000"> </span>
-# names in the source code. If set to NO (the default) only conditional<span style="background-color: #FF0000"> </span>
-# compilation will be performed. Macro expansion can be done in a controlled<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
</font> # way by setting EXPAND_ONLY_PREDEF to YES.
MACRO_EXPANSION = NO
<font color='#880000'>-# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES<span style="background-color: #FF0000"> </span>
-# then the macro expansion is limited to the macros specified with the<span style="background-color: #FF0000"> </span>
-# PREDEFINED and EXPAND_AS_PREDEFINED tags.
</font><font color='#000088'>+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
</font>
EXPAND_ONLY_PREDEF = NO
<font color='#880000'>-# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
</font> # in the INCLUDE_PATH (see below) will be search if a #include is found.
SEARCH_INCLUDES = YES
<font color='#880000'>-# The INCLUDE_PATH tag can be used to specify one or more directories that<span style="background-color: #FF0000"> </span>
-# contain include files that are not input files but should be processed by<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
</font> # the preprocessor.
<font color='#880000'>-INCLUDE_PATH =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+INCLUDE_PATH =
</font>
<font color='#880000'>-# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard<span style="background-color: #FF0000"> </span>
-# patterns (like *.h and *.hpp) to filter out the header-files in the<span style="background-color: #FF0000"> </span>
-# directories. If left blank, the patterns specified with FILE_PATTERNS will<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
</font> # be used.
<font color='#880000'>-INCLUDE_FILE_PATTERNS =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+INCLUDE_FILE_PATTERNS =
</font>
<font color='#880000'>-# The PREDEFINED tag can be used to specify one or more macro names that<span style="background-color: #FF0000"> </span>
-# are defined before the preprocessor is started (similar to the -D option of<span style="background-color: #FF0000"> </span>
-# gcc). The argument of the tag is a list of macros of the form: name<span style="background-color: #FF0000"> </span>
-# or name=definition (no spaces). If the definition and the = are<span style="background-color: #FF0000"> </span>
-# omitted =1 is assumed.
</font><font color='#000088'>+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
</font>
PREDEFINED = FALSE=0 \
<font color='#880000'>- CPU_USE_GENERIC_BITFIELD_DATA=0 \
- __attribute__(x)= \
- RTEMS_COMPILER_NO_RETURN_ATTRIBUTE= \
- RTEMS_COMPILER_DEPRECATED_ATTRIBUTE=
-
-# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then<span style="background-color: #FF0000"> </span>
-# this tag can be used to specify a list of macro names that should be expanded.<span style="background-color: #FF0000"> </span>
-# The macro definition that is found in the sources will be used.<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+ CPU_USE_GENERIC_BITFIELD_DATA=0 \
+ __attribute__(x)= \
+ RTEMS_COMPILER_NO_RETURN_ATTRIBUTE= \
+ RTEMS_COMPILER_DEPRECATED_ATTRIBUTE=
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
</font> # Use the PREDEFINED tag if you want to use a different macro definition.
<font color='#880000'>-EXPAND_AS_DEFINED =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+EXPAND_AS_DEFINED =
</font>
<font color='#880000'>-# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then<span style="background-color: #FF0000"> </span>
-# doxygen's preprocessor will remove all function-like macros that are alone<span style="background-color: #FF0000"> </span>
-# on a line, have an all uppercase name, and do not end with a semicolon. Such<span style="background-color: #FF0000"> </span>
-# function macros are typically used for boiler-plate code, and will confuse the<span style="background-color: #FF0000"> </span>
-# parser if not removed.
</font><font color='#000088'>+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all function-like macros that are alone
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
+# function macros are typically used for boiler-plate code, and will confuse
+# the parser if not removed.
</font>
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
<font color='#880000'>-# Configuration::addtions related to external references<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# Configuration::additions related to external references
</font> #---------------------------------------------------------------------------
<font color='#880000'>-# The TAGFILES option can be used to specify one or more tagfiles.<span style="background-color: #FF0000"> </span>
-# Optionally an initial location of the external documentation<span style="background-color: #FF0000"> </span>
-# can be added for each tagfile. The format of a tag file without<span style="background-color: #FF0000"> </span>
-# this location is as follows:<span style="background-color: #FF0000"> </span>
-# TAGFILES = file1 file2 ...<span style="background-color: #FF0000"> </span>
-# Adding location for the tag files is done as follows:<span style="background-color: #FF0000"> </span>
-# TAGFILES = file1=loc1 "file2 = loc2" ...<span style="background-color: #FF0000"> </span>
-# where "loc1" and "loc2" can be relative or absolute paths or<span style="background-color: #FF0000"> </span>
-# URLs. If a location is present for each tag, the installdox tool<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+#
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+#
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
</font> # does not have to be run to correct the links.
# Note that each tag file must have a unique name
# (where the name does NOT include the path)
<font color='#880000'>-# If a tag file is not located in the directory in which doxygen<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If a tag file is not located in the directory in which doxygen
</font> # is run, you must also specify the path to the tagfile here.
<font color='#880000'>-TAGFILES =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+TAGFILES =
</font>
<font color='#880000'>-# When a file name is specified after GENERATE_TAGFILE, doxygen will create<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
</font> # a tag file that is based on the input files it reads.
<font color='#880000'>-GENERATE_TAGFILE =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+GENERATE_TAGFILE =
</font>
<font color='#880000'>-# If the ALLEXTERNALS tag is set to YES all external classes will be listed<span style="background-color: #FF0000"> </span>
-# in the class index. If set to NO only the inherited external classes<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
</font> # will be listed.
ALLEXTERNALS = NO
<font color='#880000'>-# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed<span style="background-color: #FF0000"> </span>
-# in the modules index. If set to NO, only the current project's groups will<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
</font> # be listed.
EXTERNAL_GROUPS = YES
<font color='#880000'>-# The PERL_PATH should be the absolute path and name of the perl script<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The PERL_PATH should be the absolute path and name of the perl script
</font> # interpreter (i.e. the result of `which perl').
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
<font color='#880000'>-# Configuration options related to the dot tool<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# Configuration options related to the dot tool
</font> #---------------------------------------------------------------------------
<font color='#880000'>-# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will<span style="background-color: #FF0000"> </span>
-# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or<span style="background-color: #FF0000"> </span>
-# super classes. Setting the tag to NO turns the diagrams off. Note that this<span style="background-color: #FF0000"> </span>
-# option is superceded by the HAVE_DOT option below. This is only a fallback. It is<span style="background-color: #FF0000"> </span>
-# recommended to install and use dot, since it yields more powerful graphs.
</font><font color='#000088'>+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option is superseded by the HAVE_DOT option below. This is only a
+# fallback. It is recommended to install and use dot, since it yields more
+# powerful graphs.
</font>
CLASS_DIAGRAMS = YES
<font color='#880000'>-# If set to YES, the inheritance and collaboration graphs will hide<span style="background-color: #FF0000"> </span>
-# inheritance and usage relations if the target is undocumented<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH =
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
</font> # or is not a class.
HIDE_UNDOC_RELATIONS = YES
<font color='#880000'>-# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is<span style="background-color: #FF0000"> </span>
-# available from the path. This tool is part of Graphviz, a graph visualization<span style="background-color: #FF0000"> </span>
-# toolkit from AT&T and Lucent Bell Labs. The other options in this section<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
</font> # have no effect if this option is set to NO (the default)
HAVE_DOT = YES
<font color='#880000'>-# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen<span style="background-color: #FF0000"> </span>
-# will generate a graph for each documented class showing the direct and<span style="background-color: #FF0000"> </span>
-# indirect inheritance relations. Setting this tag to YES will force the<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# By default doxygen will write a font called FreeSans.ttf to the output
+# directory and reference it in all dot files that doxygen generates. This
+# font does not include all possible unicode characters however, so when you need
+# these (or just want a differently looking font) you can specify the font name
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
+# which can be done by putting it in a standard location or by setting the
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
+# containing the font.
+
+DOT_FONTNAME = FreeSans
+
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
+# The default size is 10pt.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the output directory to look for the
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a
+# different font using DOT_FONTNAME you can set the path where dot
+# can find it using this tag.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
</font> # the CLASS_DIAGRAMS tag to NO.
CLASS_GRAPH = YES
<font color='#880000'>-# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen<span style="background-color: #FF0000"> </span>
-# will generate a graph for each documented class showing the direct and<span style="background-color: #FF0000"> </span>
-# indirect implementation dependencies (inheritance, containment, and<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
</font> # class references variables) of the class with other documented classes.
COLLABORATION_GRAPH = YES
<font color='#880000'>-# If the UML_LOOK tag is set to YES doxygen will generate inheritance and<span style="background-color: #FF0000"> </span>
-# collaboration diagrams in a style similiar to the OMG's Unified Modeling<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
</font> # Language.
UML_LOOK = NO
<font color='#880000'>-# If set to YES, the inheritance and collaboration graphs will show the<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If set to YES, the inheritance and collaboration graphs will show the
</font> # relations between templates and their instances.
TEMPLATE_RELATIONS = NO
<font color='#880000'>-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT<span style="background-color: #FF0000"> </span>
-# tags are set to YES then doxygen will generate a graph for each documented<span style="background-color: #FF0000"> </span>
-# file showing the direct and indirect include dependencies of the file with<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
</font> # other documented files.
INCLUDE_GRAPH = NO
<font color='#880000'>-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and<span style="background-color: #FF0000"> </span>
-# HAVE_DOT tags are set to YES then doxygen will generate a graph for each<span style="background-color: #FF0000"> </span>
-# documented header file showing the documented files that directly or<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
</font> # indirectly include this file.
INCLUDED_BY_GRAPH = NO
<font color='#880000'>-# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will<span style="background-color: #FF0000"> </span>
-# generate a call dependency graph for every global function or class method.<span style="background-color: #FF0000"> </span>
-# Note that enabling this option will significantly increase the time of a run.<span style="background-color: #FF0000"> </span>
-# So in most cases it will be better to enable call graphs for selected<span style="background-color: #FF0000"> </span>
-# functions only using the \callgraph command.
</font><font color='#000088'>+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
+# doxygen will generate a call dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
</font>
CALL_GRAPH = NO
<font color='#880000'>-# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
</font> # will graphical hierarchy of all classes instead of a textual one.
GRAPHICAL_HIERARCHY = YES
<font color='#880000'>-# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
</font> # generated by dot. Possible values are png, jpg, or gif
# If left blank png will be used.
DOT_IMAGE_FORMAT = png
<font color='#880000'>-# The tag DOT_PATH can be used to specify the path where the dot tool can be<span style="background-color: #FF0000"> </span>
-# found. If left blank, it is assumed the dot tool can be found on the path.
</font><font color='#000088'>+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
</font>
<font color='#880000'>-DOT_PATH =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+DOT_PATH =
</font>
<font color='#880000'>-# The DOTFILE_DIRS tag can be used to specify one or more directories that<span style="background-color: #FF0000"> </span>
-# contain dot files that are included in the documentation (see the<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
</font> # \dotfile command).
<font color='#880000'>-DOTFILE_DIRS =<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+DOTFILE_DIRS =
</font>
<font color='#880000'>-# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width<span style="background-color: #FF0000"> </span>
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than<span style="background-color: #FF0000"> </span>
-# this value, doxygen will try to truncate the graph, so that it fits within<span style="background-color: #FF0000"> </span>
-# the specified constraint. Beware that most browsers cannot cope with very<span style="background-color: #FF0000"> </span>
-# large images.
-
-MAX_DOT_GRAPH_WIDTH = 1024
-
-# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height<span style="background-color: #FF0000"> </span>
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than<span style="background-color: #FF0000"> </span>
-# this value, doxygen will try to truncate the graph, so that it fits within<span style="background-color: #FF0000"> </span>
-# the specified constraint. Beware that most browsers cannot cope with very<span style="background-color: #FF0000"> </span>
-# large images.
-
-MAX_DOT_GRAPH_HEIGHT = 1024
-
-# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the<span style="background-color: #FF0000"> </span>
-# graphs generated by dot. A depth value of 3 means that only nodes reachable<span style="background-color: #FF0000"> </span>
-# from the root by following a path via at most 3 edges will be shown. Nodes that<span style="background-color: #FF0000"> </span>
-# lay further from the root node will be omitted. Note that setting this option to<span style="background-color: #FF0000"> </span>
-# 1 or 2 may greatly reduce the computation time needed for large code bases. Also<span style="background-color: #FF0000"> </span>
-# note that a graph may be further truncated if the graph's image dimensions are<span style="background-color: #FF0000"> </span>
-# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).<span style="background-color: #FF0000"> </span>
-# If 0 is used for the depth value (the default), the graph is not depth-constrained.
</font><font color='#000088'>+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
</font>
MAX_DOT_GRAPH_DEPTH = 0
<font color='#880000'>-# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will<span style="background-color: #FF0000"> </span>
-# generate a legend page explaining the meaning of the various boxes and<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not
+# seem to support this out of the box. Warning: Depending on the platform used,
+# enabling this option may lead to badly anti-aliased labels on the edges of
+# a graph (i.e. they become hard to read).
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
</font> # arrows in the dot generated graphs.
GENERATE_LEGEND = YES
<font color='#880000'>-# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will<span style="background-color: #FF0000"> </span>
-# remove the intermediate dot files that are used to generate<span style="background-color: #FF0000"> </span>
</font><font color='#000088'>+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
</font> # the various graphs.
DOT_CLEANUP = YES
<font color='#880000'>-
-#---------------------------------------------------------------------------
-# Configuration::addtions related to the search engine<span style="background-color: #FF0000"> </span>
-#---------------------------------------------------------------------------
-
-# The SEARCHENGINE tag specifies whether or not a search engine should be<span style="background-color: #FF0000"> </span>
-# used. If set to NO the values of all tags below this one will be ignored.
-
-SEARCHENGINE = NO
</font></pre>
<p> </p>
<a name='cs5'></a>
<table border='0' cellspacing='0' cellpadding='5' width='100%' bgcolor='#eeeeee'>
<tr><td colspan='3' bgcolor='#dddddd'>
<font color='#bb2222'><strong>ralf</strong></font>
</td></tr>
<tr><td colspan='3' bgcolor='#dddddd'><pre>2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
* Doxygen.in: Activate INCLUDE_GRAPH and
INCLUDED_BY_GRAPH.
</pre></td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/ChangeLog.diff?r1=text&tr1=1.2371&r2=text&tr2=1.2372&diff_format=h">M</a></td><td width='1%'>1.2372</td><td width='100%'>cpukit/ChangeLog</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/cpukit/Doxyfile.in.diff?r1=text&tr1=1.4&r2=text&tr2=1.5&diff_format=h">M</a></td><td width='1%'>1.5</td><td width='100%'>cpukit/Doxyfile.in</td></tr>
</table>
<pre>
<font color='#006600'>diff -u rtems/cpukit/ChangeLog:1.2371 rtems/cpukit/ChangeLog:1.2372
--- rtems/cpukit/ChangeLog:1.2371 Sat Jun 12 00:56:26 2010
+++ rtems/cpukit/ChangeLog Sat Jun 12 01:10:03 2010
</font><font color='#997700'>@@ -1,5 +1,10 @@
</font> 2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
<font color='#000088'>+ * Doxygen.in: Activate INCLUDE_GRAPH and<span style="background-color: #FF0000"> </span>
+ INCLUDED_BY_GRAPH.
+
+2010-06-12 Ralf Corsépius <ralf.corsepius@rtems.org>
+
</font> * score/include/rtems/score/timestamp.h,
score/include/rtems/score/timestamp64.h,
score/include/rtems/score/watchdog.h:
<font color='#006600'>diff -u rtems/cpukit/Doxyfile.in:1.4 rtems/cpukit/Doxyfile.in:1.5
--- rtems/cpukit/Doxyfile.in:1.4 Sat Jun 12 01:08:39 2010
+++ rtems/cpukit/Doxyfile.in Sat Jun 12 01:10:04 2010
</font><font color='#997700'>@@ -1459,14 +1459,14 @@
</font> # file showing the direct and indirect include dependencies of the file with
# other documented files.
<font color='#880000'>-INCLUDE_GRAPH = NO
</font><font color='#000088'>+INCLUDE_GRAPH = YES
</font>
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
# documented header file showing the documented files that directly or
# indirectly include this file.
<font color='#880000'>-INCLUDED_BY_GRAPH = NO
</font><font color='#000088'>+INCLUDED_BY_GRAPH = YES
</font>
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
# doxygen will generate a call dependency graph for every global function
</pre>
<p> </p>
<p>--<br />
<small>Generated by <a href="http://www.codewiz.org/projects/index.html#loginfo">Deluxe Loginfo</a> 2.122 by Bernardo Innocenti <bernie@develer.com></small></p>
</body>
</html>