Commit 4dc35070 authored by Josh Coalson's avatar Josh Coalson
Browse files

more doxygen docs

parent a37ba46b
......@@ -30,6 +30,10 @@
* that encapsulate the encoders, decoders, and metadata interfaces
* in libFLAC.
*
* Note that Doxygen currently has some quirks (bugs?) in the way
* it deals with some member groups and C++ constructs. You will find
* some document entries in the wrong place under [NOHEADER] sections.
* Hopefully this is not too annoying.
*/
#endif
......@@ -57,10 +57,10 @@ namespace FLAC {
// ============================================================
//
// The only real difference here is that instead of passing
// in C function pointers for callbacks, you inherit from
// stream and provide implementations for the callbacks in
// the derived class; because of this there is no need for a
// 'client_data' property.
// in C function pointers for callbacks, you inherit from the
// decoder class and provide implementations for the callbacks
// in the derived class; because of this there is no need for
// a 'client_data' property.
//
// ============================================================
......
......@@ -62,10 +62,10 @@ namespace FLAC {
// ----------------------------------------------------------
//
// The only real difference here is that instead of passing
// in C function pointers for callbacks, you inherit from
// stream and provide implementations for the callbacks in
// the derived class; because of this there is no need for a
// 'client_data' property.
// in C function pointers for callbacks, you inherit from the
// encoder class and provide implementations for the callbacks
// in the derived class; because of this there is no need for
// a 'client_data' property.
//
// ============================================================
......
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment