2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com>

	* rtems/include/rtems.h, rtems/include/rtems/rtems/asr.h,
	rtems/include/rtems/rtems/attr.h,
	rtems/include/rtems/rtems/barrier.h,
	rtems/include/rtems/rtems/barriermp.h,
	rtems/include/rtems/rtems/cache.h, rtems/include/rtems/rtems/clock.h,
	rtems/include/rtems/rtems/config.h,
	rtems/include/rtems/rtems/dpmem.h, rtems/include/rtems/rtems/event.h,
	rtems/include/rtems/rtems/eventmp.h,
	rtems/include/rtems/rtems/eventset.h,
	rtems/include/rtems/rtems/intr.h,
	rtems/include/rtems/rtems/message.h,
	rtems/include/rtems/rtems/modes.h, rtems/include/rtems/rtems/mp.h,
	rtems/include/rtems/rtems/msgmp.h,
	rtems/include/rtems/rtems/object.h,
	rtems/include/rtems/rtems/options.h,
	rtems/include/rtems/rtems/part.h, rtems/include/rtems/rtems/partmp.h,
	rtems/include/rtems/rtems/ratemon.h,
	rtems/include/rtems/rtems/region.h,
	rtems/include/rtems/rtems/regionmp.h,
	rtems/include/rtems/rtems/rtemsapi.h,
	rtems/include/rtems/rtems/sem.h, rtems/include/rtems/rtems/semmp.h,
	rtems/include/rtems/rtems/signal.h,
	rtems/include/rtems/rtems/signalmp.h,
	rtems/include/rtems/rtems/status.h,
	rtems/include/rtems/rtems/support.h,
	rtems/include/rtems/rtems/taskmp.h,
	rtems/include/rtems/rtems/tasks.h, rtems/include/rtems/rtems/timer.h,
	rtems/include/rtems/rtems/types.h, rtems/inline/rtems/rtems/asr.inl,
	rtems/inline/rtems/rtems/attr.inl,
	rtems/inline/rtems/rtems/barrier.inl,
	rtems/inline/rtems/rtems/dpmem.inl,
	rtems/inline/rtems/rtems/event.inl,
	rtems/inline/rtems/rtems/eventset.inl,
	rtems/inline/rtems/rtems/message.inl,
	rtems/inline/rtems/rtems/modes.inl,
	rtems/inline/rtems/rtems/options.inl,
	rtems/inline/rtems/rtems/part.inl,
	rtems/inline/rtems/rtems/ratemon.inl,
	rtems/inline/rtems/rtems/region.inl,
	rtems/inline/rtems/rtems/sem.inl,
	rtems/inline/rtems/rtems/status.inl,
	rtems/inline/rtems/rtems/support.inl,
	rtems/inline/rtems/rtems/tasks.inl,
	rtems/inline/rtems/rtems/timer.inl: Initial conversion of Classic API
	header files to Doxygen.
	* rtems/Doxyfile: New file.

1 files changed, 37 insertions, 21 deletions

diff --git a/cpukit/rtems/include/rtems/rtems/cache.h b/cpukit/rtems/include/rtems/rtems/cache.h
index 17645346c3..c90b240f2b 100644
--- a/cpukit/rtems/include/rtems/rtems/cache.h
+++ b/cpukit/rtems/include/rtems/rtems/cache.h
@@ -1,11 +1,10 @@
 /**
  * @file rtems/rtems/cache.h
+ *
+ *  Cache Manager
  */
 
-/*
- *  Cache Manager
- *
- *  COPYRIGHT (c) 1989-1999.
+/*  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -38,97 +37,112 @@ extern "C" {
 #include <rtems/system.h>
 #include <sys/types.h>
 
+/**
+ *  @defgroup ClassicCache Classic API Cache
+ *
+ *  This encapsulates functionality which XXX
+ */
+/**@{*/
+
 /*
  *  These functions will ONLY do something if the
  *  libcpu support includes data cache routines AND
  *  the CPU model supports data caching.
  */
 
-/*
+/**
  * This function is called to flush the data cache by performing cache
  * copybacks. It must determine how many cache lines need to be copied
  * back and then perform the copybacks.
  */
 void rtems_cache_flush_multiple_data_lines( const void *, size_t );
 
-/*
+/**
  * This function is responsible for performing a data cache invalidate.
  * It must determine how many cache lines need to be invalidated and then
  * perform the invalidations.
  */
 void rtems_cache_invalidate_multiple_data_lines( const void *, size_t );
 
-/*
+/**
  * This function is responsible for performing a data cache flush.
  * It flushes the entire cache.
  */
 void rtems_cache_flush_entire_data( void );
 
-/*
+/**
  * This function is responsible for performing a data cache
  * invalidate. It invalidates the entire cache.
  */
 void rtems_cache_invalidate_entire_data( void );
 
-/*
+/**
  * This function returns the data cache granularity.
  */
 int rtems_cache_get_data_line_size( void );
 
-/*
+/**
  * This function freezes the data cache.
  */
 void rtems_cache_freeze_data( void );
 
-/*
+/**
  * This function unfreezes the data cache.
  */
 void rtems_cache_unfreeze_data( void );
 
-/*
- * These functions enable/disable the data cache.
+/**
+ * This function enables the data cache.
  */
 void rtems_cache_enable_data( void );
+
+/**
+ * This function disables the data cache.
+ */
 void rtems_cache_disable_data( void );
 
-/*
+/**
  *  These functions will ONLY do something if the
  *  libcpu support includes instruction cache routines AND
  *  the CPU model supports instruction caching.
  */
 
-/*
+/**
  * This function is responsible for performing an instruction cache
  * invalidate. It must determine how many cache lines need to be invalidated
  * and then perform the invalidations.
  */
 void rtems_cache_invalidate_multiple_instruction_lines( const void *, size_t );
 
-/*
+/**
  * This function is responsible for performing an instruction cache
  * invalidate. It invalidates the entire cache.
  */
 void rtems_cache_invalidate_entire_instruction( void );
 
-/*
+/**
  * This function returns the instruction cache granularity.
  */
 int rtems_cache_get_instruction_line_size( void );
 
-/*
+/**
  * This function freezes the instruction cache.
  */
 void rtems_cache_freeze_instruction( void );
 
-/*
+/**
  * This function unfreezes the instruction cache.
  */
 void rtems_cache_unfreeze_instruction( void );
 
-/*
- * These functions enable/disable the instruction cache.
+/**
+ * This function enables the instruction cache.
  */
 void rtems_cache_enable_instruction( void );
+
+/**
+ * This function disables the instruction cache.
+ */
 void rtems_cache_disable_instruction( void );
 
 
@@ -136,5 +150,7 @@ void rtems_cache_disable_instruction( void );
 }
 #endif
 
+/**@}*/
+
 #endif
 /* end of include file */