document that PA_API_VERSION is only for incompatible API changes

This commit is contained in:
Lennart Poettering 2009-01-15 00:03:33 +01:00
parent 20edd846d0
commit fd3f5db63c

View file

@ -43,7 +43,8 @@ const char* pa_get_library_version(void);
/** The current API version. Version 6 relates to Polypaudio
* 0.6. Prior versions (i.e. Polypaudio 0.5.1 and older) have
* PA_API_VERSION undefined. */
* PA_API_VERSION undefined. Please note that this is only ever
* increased on incompatible API changes! */
#define PA_API_VERSION @PA_API_VERSION@
/** The current protocol version. Version 8 relates to Polypaudio