2009-05-15 Sebastian Huber <sebastian.huber@embedded-brains.de>

	* Doxygen.in: Fixed project name.  Added project number.  Enabled auto
	brief.  Disabled include graphs.
	* include/rtems/irq-extension.h, libblock/include/rtems/bdpart.h,
	libblock/include/rtems/bdbuf.h, libblock/include/rtems/bdpart.h,
	libblock/include/rtems/blkdev.h, libblock/include/rtems/diskdevs.h,
	libblock/include/rtems/ramdisk.h, libblock/src/bdbuf.c,
	libblock/src/blkdev.c, libblock/src/diskdevs.c, libblock/src/ramdisk.c:
	Documentation.
	* libblock/src/bdpart.c: Documentation.  Fixed NULL pointer access.

12 files changed, 50 insertions, 22 deletions

diff --git a/cpukit/Doxyfile.in b/cpukit/Doxyfile.in
index 3eff816155..a3195a65ed 100644
--- a/cpukit/Doxyfile.in
+++ b/cpukit/Doxyfile.in
@@ -17,13 +17,13 @@
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
 # by quotes) that should identify the project.
 
-PROJECT_NAME           = RTEMS CPU Kit including SuperCore
+PROJECT_NAME           = "RTEMS CPU Kit with SuperCore"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
 # This could be handy for archiving the generated documentation or 
 # if some version control system is used.
 
-PROJECT_NUMBER         = 
+PROJECT_NUMBER         = @PACKAGE_VERSION@
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 
@@ -105,7 +105,15 @@ SHORT_NAMES            = NO
 # comments will behave just like the Qt-style comments (thus requiring an 
 # explict @brief command for a brief description.
 
-JAVADOC_AUTOBRIEF      = NO
+JAVADOC_AUTOBRIEF      = YES
+
+# 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 
+# an explicit \brief command for a brief description.)
+
+QT_AUTOBRIEF           = YES
 
 # 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 /// 
@@ -876,7 +884,10 @@ INCLUDE_FILE_PATTERNS  =
 # omitted =1 is assumed.
 
 PREDEFINED             = FALSE=0 \
-   CPU_USE_GENERIC_BITFIELD_DATA=0
+   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. 
@@ -991,14 +1002,14 @@ TEMPLATE_RELATIONS     = NO
 # file showing the direct and indirect include dependencies of the file with 
 # other documented files.
 
-INCLUDE_GRAPH          = YES
+INCLUDE_GRAPH          = NO
 
 # 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.
 
-INCLUDED_BY_GRAPH      = YES
+INCLUDED_BY_GRAPH      = NO
 
 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
 # generate a call dependency graph for every global function or class method. 
diff --git a/cpukit/include/rtems/irq-extension.h b/cpukit/include/rtems/irq-extension.h
index 20324fe1f4..ddc4b58af9 100644
--- a/cpukit/include/rtems/irq-extension.h
+++ b/cpukit/include/rtems/irq-extension.h
@@ -3,7 +3,7 @@
  *
  * @ingroup rtems_interrupt_extension
  *
- * @brief Header file for the RTEMS Interrupt Manager Extension.
+ * @brief Header file for the Interrupt Manager Extension.
  */
 
 /*
@@ -30,7 +30,7 @@ extern "C" {
 #endif /* __cplusplus */
 
 /**
- * @defgroup rtems_interrupt_extension RTEMS Interrupt Manager Extension
+ * @defgroup rtems_interrupt_extension Interrupt Manager Extension
  *
  * @ingroup ClassicINTR
  *
diff --git a/cpukit/libblock/include/rtems/bdbuf.h b/cpukit/libblock/include/rtems/bdbuf.h
index 52ee557054..1f79f89d0d 100644
--- a/cpukit/libblock/include/rtems/bdbuf.h
+++ b/cpukit/libblock/include/rtems/bdbuf.h
@@ -1,6 +1,8 @@
 /**
  * @file
  *
+ * @ingroup rtems_bdbuf
+ *
  * Block device buffer management.
  */
  
diff --git a/cpukit/libblock/include/rtems/bdpart.h b/cpukit/libblock/include/rtems/bdpart.h
index dc52b1c89c..56e6363e5a 100644
--- a/cpukit/libblock/include/rtems/bdpart.h
+++ b/cpukit/libblock/include/rtems/bdpart.h
@@ -1,6 +1,8 @@
 /**
  * @file
  *
+ * @ingroup rtems_bdpart
+ *
  * Block device partition management.
  */
 
@@ -245,11 +247,11 @@ rtems_status_code rtems_bdpart_write(
  * Creates a partition table in @a partitions with @a count partitions for the
  * physical disk device with name @a disk_name.
  *
- * The array of positive integer weights in @a distribution must be of size @a
- * size.  The weights in the distribution array are summed up.  Each weight is
- * then divided by the sum to obtain the disk fraction which forms the
- * corresponding partition.  The partition boundaries are generated with
- * respect to the output format in @a format.
+ * The array of positive integer weights in @a distribution must have exactly
+ * @a count elements.  The weights in the distribution array are summed up.
+ * Each weight is then divided by the sum to obtain the disk fraction which
+ * forms the corresponding partition.  The partition boundaries are generated
+ * with respect to the output format in @a format.
  */
 rtems_status_code rtems_bdpart_create(
   const char *disk_name,
diff --git a/cpukit/libblock/include/rtems/blkdev.h b/cpukit/libblock/include/rtems/blkdev.h
index f7a7a9eb70..40a7541731 100644
--- a/cpukit/libblock/include/rtems/blkdev.h
+++ b/cpukit/libblock/include/rtems/blkdev.h
@@ -1,6 +1,8 @@
 /**
  * @file
  *
+ * @ingroup rtems_blkdev
+ *
  * Block device management.
  */
  
diff --git a/cpukit/libblock/include/rtems/diskdevs.h b/cpukit/libblock/include/rtems/diskdevs.h
index b5254eec5f..e48b61e53c 100644
--- a/cpukit/libblock/include/rtems/diskdevs.h
+++ b/cpukit/libblock/include/rtems/diskdevs.h
@@ -1,6 +1,8 @@
 /**
  * @file
  *
+ * @ingroup rtems_disk
+ *
  * Block device disk management.
  */
  
diff --git a/cpukit/libblock/include/rtems/ramdisk.h b/cpukit/libblock/include/rtems/ramdisk.h
index 62b1293a8a..a1f5927f14 100644
--- a/cpukit/libblock/include/rtems/ramdisk.h
+++ b/cpukit/libblock/include/rtems/ramdisk.h
@@ -1,6 +1,8 @@
 /**
  * @file
  *
+ * @ingroup rtems_ramdisk
+ *
  * RAM disk block device.
  */
 
diff --git a/cpukit/libblock/src/bdbuf.c b/cpukit/libblock/src/bdbuf.c
index 6ae6c4dccc..8be4bd8180 100644
--- a/cpukit/libblock/src/bdbuf.c
+++ b/cpukit/libblock/src/bdbuf.c
@@ -1,6 +1,8 @@
 /**
  * @file
  *
+ * @ingroup rtems_bdbuf
+ *
  * Block device buffer management.
  */
 
diff --git a/cpukit/libblock/src/bdpart.c b/cpukit/libblock/src/bdpart.c
index b86780ccf4..355bd8014d 100644
--- a/cpukit/libblock/src/bdpart.c
+++ b/cpukit/libblock/src/bdpart.c
@@ -1,6 +1,8 @@
 /**
  * @file
  *
+ * @ingroup rtems_bdpart
+ *
  * Block device partition management.
  */
 
@@ -319,7 +321,7 @@ rtems_status_code rtems_bdpart_read(
   rtems_status_code esc = RTEMS_SUCCESSFUL;
   rtems_bdbuf_buffer *block = NULL;
   rtems_bdpart_partition *p = pt - 1;
-  rtems_bdpart_partition *p_end = NULL;
+  const rtems_bdpart_partition *p_end = pt + (count != NULL ? *count : 0);
   rtems_blkdev_bnum ep_begin = 0; /* Extended partition begin */
   rtems_blkdev_bnum ebr = 0; /* Extended boot record block index */
   rtems_blkdev_bnum disk_end = 0;
@@ -332,8 +334,7 @@ rtems_status_code rtems_bdpart_read(
     return RTEMS_INVALID_ADDRESS;
   }
 
-  /* Set table end and the count to a save value */
-  p_end = pt + *count;
+  /* Set count to a save value */
   *count = 0;
 
   /* Get disk data */
@@ -463,7 +464,8 @@ rtems_status_code rtems_bdpart_write(
 {
   rtems_status_code sc = RTEMS_SUCCESSFUL;
   rtems_status_code esc = RTEMS_SUCCESSFUL;
-  bool dos_compatibility = format->type == RTEMS_BDPART_FORMAT_MBR
+  bool dos_compatibility = format != NULL
+    && format->type == RTEMS_BDPART_FORMAT_MBR
     && format->mbr.dos_compatibility;
   rtems_bdbuf_buffer *block = NULL;
   rtems_blkdev_bnum disk_end = 0;
@@ -680,7 +682,8 @@ rtems_status_code rtems_bdpart_create(
 )
 {
   rtems_status_code sc = RTEMS_SUCCESSFUL;
-  bool dos_compatibility = format->type == RTEMS_BDPART_FORMAT_MBR
+  bool dos_compatibility = format != NULL
+    && format->type == RTEMS_BDPART_FORMAT_MBR
     && format->mbr.dos_compatibility;
   rtems_blkdev_bnum disk_end = 0;
   rtems_blkdev_bnum pos = 0;
diff --git a/cpukit/libblock/src/blkdev.c b/cpukit/libblock/src/blkdev.c
index fd5b7f09b0..341bccf4e5 100644
--- a/cpukit/libblock/src/blkdev.c
+++ b/cpukit/libblock/src/blkdev.c
@@ -1,12 +1,12 @@
 /**
  * @file
  *
+ * @ingroup rtems_blkdev
+ *
  * Block device management.
  */
  
 /*
- * blkdev.h - block device driver generic support
- *
  * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
  * Author: Victor V. Vengerov <vvv@oktet.ru>
  *
diff --git a/cpukit/libblock/src/diskdevs.c b/cpukit/libblock/src/diskdevs.c
index f888246e36..0f94615a0d 100644
--- a/cpukit/libblock/src/diskdevs.c
+++ b/cpukit/libblock/src/diskdevs.c
@@ -1,12 +1,12 @@
 /**
  * @file
  *
+ * @ingroup rtems_disk
+ *
  * Block device disk management.
  */
  
 /*
- * diskdevs.c - Physical and logical block devices (disks) support
- *
  * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
  * Author: Victor V. Vengerov <vvv@oktet.ru>
  *
diff --git a/cpukit/libblock/src/ramdisk.c b/cpukit/libblock/src/ramdisk.c
index 0b18ad34f8..5684f302df 100644
--- a/cpukit/libblock/src/ramdisk.c
+++ b/cpukit/libblock/src/ramdisk.c
@@ -1,6 +1,8 @@
 /**
  * @file
  *
+ * @ingroup rtems_ramdisk
+ *
  * RAM disk block device.
  */