more doxygen docs

include/FLAC++/all.h

@@ -24,4 +24,12 @@
 #include "decoder.h"
 #include "metadata.h"
 
+/** \defgroup flacpp FLAC C++ API
+ *
+ * The FLAC C++ API is the interface to libFLAC++, a set of classes
+ * that encapsulate the encoders, decoders, and metadata interfaces
+ * in libFLAC.
+ *
+ */
+
 #endif

include/FLAC++/decoder.h

@@ -32,6 +32,25 @@
 // ===============================================================
 
 
+/** \file include/FLAC++/decoder.h
+ *
+ *  \brief
+ *  This file contains the classes which implement the various
+ *  decoders.
+ *
+ *  See the detailed documentation in the
+ *  \link flacpp_decoder decoder \endlink module.
+ */
+
+/** \defgroup flacpp_decoder FLAC++/decoder.h: decoder classes
+ *  \ingroup flacpp
+ *
+ *  \brief
+ *  Brief XXX.
+ *
+ * Detailed decoder XXX.
+ */
+
 namespace FLAC {
 	namespace Decoder {
 
@@ -51,6 +70,18 @@ namespace FLAC {
 		//
 		// ============================================================
 
+		/** \defgroup flacpp_stream_decoder FLAC++/decoder.h: stream decoder class
+		 *  \ingroup flacpp_decoder
+		 *
+		 *  \brief
+		 *  Brief XXX.
+		 *
+		 * Detailed stream decoder XXX.
+		 * \{
+		 */
+
+		/** stream decoder XXX.
+		 */
 		class Stream {
 		public:
 			class State {
@@ -114,12 +145,27 @@ namespace FLAC {
 			void operator=(const Stream &);
 		};
 
+		/* \} */
+
+
 		// ============================================================
 		//
 		//  Equivalent: FLAC__SeekableStreamDecoder
 		//
 		// ============================================================
 
+		/** \defgroup flacpp_seekable_stream_decoder FLAC++/decoder.h: seekable stream decoder class
+		 *  \ingroup flacpp_decoder
+		 *
+		 *  \brief
+		 *  Brief XXX.
+		 *
+		 * Detailed seekable stream decoder XXX.
+		 * \{
+		 */
+
+		/** seekable stream decoder XXX.
+		 */
 		class SeekableStream {
 		public:
 			class State {
@@ -192,12 +238,27 @@ namespace FLAC {
 			void operator=(const SeekableStream &);
 		};
 
+		/* \} */
+
+
 		// ============================================================
 		//
 		//  Equivalent: FLAC__FileDecoder
 		//
 		// ============================================================
 
+		/** \defgroup flacpp_file_decoder FLAC++/decoder.h: file decoder class
+		 *  \ingroup flacpp_decoder
+		 *
+		 *  \brief
+		 *  Brief XXX.
+		 *
+		 * Detailed file decoder XXX.
+		 * \{
+		 */
+
+		/** file decoder XXX.
+		 */
 		class File {
 		public:
 			class State {
@@ -258,6 +319,8 @@ namespace FLAC {
 			void operator=(const File &);
 		};
 
+		/* \} */
+
 	};
 };
 

include/FLAC++/encoder.h

@@ -30,6 +30,25 @@
 // ===============================================================
 
 
+/** \file include/FLAC++/encoder.h
+ *
+ *  \brief
+ *  This module contains the classes which implement the various
+ *  encoders.
+ *
+ *  See the detailed documentation in the
+ *  \link flacpp_encoder encoder \endlink module.
+ */
+
+/** \defgroup flacpp_encoder FLAC++/encoder.h: encoder classes
+ *  \ingroup flacpp
+ *
+ *  \brief
+ *  Brief XXX.
+ *
+ * Detailed encoder XXX.
+ */
+
 namespace FLAC {
 	namespace Encoder {
 
@@ -47,6 +66,18 @@ namespace FLAC {
 		//
 		// ============================================================
 
+		/** \defgroup flacpp_stream_encoder FLAC++/encoder.h: stream encoder class
+		 *  \ingroup flacpp_encoder
+		 *
+		 *  \brief
+		 *  Brief XXX.
+		 *
+		 * Detailed stream encoder XXX.
+		 * \{
+		 */
+
+		/** stream encoder XXX.
+		 */
 		class Stream {
 		public:
 			class State {
@@ -122,6 +153,8 @@ namespace FLAC {
 			void operator=(const Stream &);
 		};
 
+		/* \} */
+
 	};
 };
 

include/FLAC/file_decoder.h

@@ -188,7 +188,7 @@ FLAC__FileDecoder *FLAC__file_decoder_new();
  * \assert
  *    \code decoder != NULL \endcode
  */
-void FLAC__file_decoder_delete(FLAC__FileDecoder *);
+void FLAC__file_decoder_delete(FLAC__FileDecoder *decoder);
 
 
 /***********************************************************************

include/FLAC/format.h

@@ -426,11 +426,22 @@ typedef struct {
 
 /** An enumeration of the available metadata block types. */
 typedef enum {
+
 	FLAC__METADATA_TYPE_STREAMINFO = 0,
+	/**< <A HREF="../format.html#metadata_block_streaminfo">STREAMINFO</A> block */
+
 	FLAC__METADATA_TYPE_PADDING = 1,
+	/**< <A HREF="../format.html#metadata_block_padding"PADDING</A> block */
+
 	FLAC__METADATA_TYPE_APPLICATION = 2,
+	/**< <A HREF="../format.html#metadata_block_application"APPLICATION</A> block */
+
 	FLAC__METADATA_TYPE_SEEKTABLE = 3,
-	FLAC__METADATA_TYPE_VORBIS_COMMENT = 4
+	/**< <A HREF="../format.html#metadata_block_seektable"SEEKTABLE</A> block */
+
+	FLAC__METADATA_TYPE_VORBIS_COMMENT = 4,
+	/**< <A HREF="../format.html#metadata_block_vorbis_comment"VORBISCOMMENT</A> block */
+
 } FLAC__MetadataType;
 
 /** Maps a FLAC__MetadataType to a C string.
@@ -440,6 +451,7 @@ typedef enum {
  */
 extern const char * const FLAC__MetadataTypeString[];
 
+
 /** FLAC STREAMINFO structure.  (c.f. <A HREF="../format.html#metadata_block_streaminfo">format specification</A>)
  */
 typedef struct {

include/FLAC/stream_decoder.h

@@ -37,7 +37,7 @@ extern "C" {
  *  \link flac_stream_decoder stream decoder \endlink module.
  */
 
-/** \defgroup flac_decoder FLAC/*_decoder.h: decoder interfaces
+/** \defgroup flac_decoder FLAC/ *_decoder.h: decoder interfaces
  *  \ingroup flac
  *
  *  \brief

include/FLAC/stream_encoder.h

@@ -37,7 +37,7 @@ extern "C" {
  *  \link flac_stream_encoder stream encoder \endlink module.
  */
 
-/** \defgroup flac_encoder FLAC/*_encoder.h: encoder interfaces
+/** \defgroup flac_encoder FLAC/ *_encoder.h: encoder interfaces
  *  \ingroup flac
  *
  *  \brief
@@ -48,11 +48,6 @@ extern "C" {
  * within a file while encoding seemed like too obscure a feature.
  */
 
-/** \defgroup flac_encoder FLAC/*_encoder.h: encoder interfaces
- *  \ingroup flac
- *
- */
-
 /** \defgroup flac_stream_encoder FLAC/stream_encoder.h: stream encoder interface
  *  \ingroup flac_encoder
  *