more doxygen docs

This commit is contained in:
Josh Coalson
2002-07-27 04:59:54 +00:00
parent adea3dea13
commit f6efd9cec9
8 changed files with 1190 additions and 50 deletions

View File

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