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 &);
 		};
 
+		/* \} */
+
 	};
 };