claunia/flac
1
0
Fork 0
mirror of https://github.com/claunia/flac.git synced 2025-12-16 18:54:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

more doxygen comments

Browse Source
This commit is contained in:
Josh Coalson
2006-10-07 05:43:01 +00:00
parent e401faa968
commit 20ad84aa61
9 changed files with 110 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
include/OggFLAC++/encoder.h
View File

@@ -141,6 +141,8 @@ namespace OggFLAC {
*/
class OggFLACPP_API Stream: public FLAC::Encoder::Stream {
public:
/** This class is a wrapper around OggFLAC__StreamEncoderState.
*/
class OggFLACPP_API State {
public:
inline State(::OggFLAC__StreamEncoderState state): state_(state) { }
@@ -233,7 +235,7 @@ namespace OggFLAC {
* \brief
* This class wraps the ::OggFLAC__FileEncoder.
*
* See the \link oggflac_file_encoder libOggFLAC file encoder module \endlink
* See the \link oggflac_stream_encoder libOggFLAC stream encoder module \endlink
* for basic usage.
*
* \{
@@ -259,21 +261,21 @@ namespace OggFLAC {
*/
class OggFLACPP_API File: public Stream {
public:
File();
virtual ~File();
//@{
/** Initialize the instance; as with the C interface,
* init() should be called after construction and 'set'
* calls but before any of the 'process' calls.
*
* See OggFLAC__stream_encoder_init_FILE() and
* OggFLAC__stream_encoder_init_file().
* \{
*/
File();
virtual ~File();
/* \} */
::FLAC__StreamEncoderInitStatus init(FILE *file);
::FLAC__StreamEncoderInitStatus init(const char *filename);
::FLAC__StreamEncoderInitStatus init(const std::string &filename);
//@}
protected:
/// See FLAC__StreamEncoderProgressCallback
virtual void progress_callback(FLAC__uint64 bytes_written, FLAC__uint64 samples_written, unsigned frames_written, unsigned total_frames_estimate);