Commit 738385a1 authored by conrad's avatar conrad

get rid of some warnings from Doxygen


git-svn-id: http://svn.annodex.net/liboggz/trunk@2095 8158c8cd-e7e1-0310-9fa4-c5954c97daef
parent d06bcb98
......@@ -306,7 +306,7 @@ extern "C" {
*/
/** \defgroup configuration Configuration
* \section ./configure ./configure
* \section configure ./configure
*
* It is possible to customize the functionality of liboggz
* by using various ./configure flags when
......
......@@ -41,7 +41,7 @@
* DEPRECATED CONSTANT.
* OGGZ_ERR_USER_STOPPED was introduced during development (post 0.8.3),
* and is similar in functionality to and numerically equal to (ie. ABI
* compatible with) OGGZ_ERR_READ_STOP_OK in <oggz/oggz_constants.h>.
* compatible with) OGGZ_ERR_STOP_OK in <oggz/oggz_constants.h>.
* It was badly named, as the preferred functionality distinguishes between
* a user's OggzReadCallback returning OGGZ_STOP_OK or OGGZ_STOP_ERR; your
* code should distinguish between these two too :-) Hence, don't use this
......@@ -50,14 +50,23 @@
#define OGGZ_ERR_USER_STOPPED OGGZ_ERR_STOP_OK
/**
* DEPRECATED CONSTANTS.
* DEPRECATED CONSTANT.
* OGGZ_ERR_READ_STOP_OK, OGGZ_ERR_READ_STOP_ERR were introduced to allow
* the user to differentiate between a cancelled oggz_read_*() returning
* due to error or an ok condition.
* From 0.9.4 similar functionality was added for oggz_write_*(), hence these
* constants were renamed appropriately.
* From 0.9.4 similar functionality was added for oggz_write_*(), hence this
* constant was renamed.
*/
#define OGGZ_ERR_READ_STOP_OK OGGZ_ERR_STOP_OK
/**
* DEPRECATED CONSTANT.
* OGGZ_ERR_READ_STOP_OK, OGGZ_ERR_READ_STOP_ERR were introduced to allow
* the user to differentiate between a cancelled oggz_read_*() returning
* due to error or an ok condition.
* From 0.9.4 similar functionality was added for oggz_write_*(), hence this
* constant was renamed.
*/
#define OGGZ_ERR_READ_STOP_ERR OGGZ_ERR_STOP_ERR
/**
......
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