me/portaudio
Watch
1
0
Fork
You've already forked portaudio
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix formatting of version API doxygen comments in portaudio.h. Add additional documentation details, see also, and version information (e.g. Available as of 19.5.0).

Browse source
This commit is contained in:
Ross Bencina 2016-09-25 17:34:16 +10:00
commit d940dcb8b8
1 changed files with 40 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

51
include/portaudio.h
View file

@ -51,52 +51,69 @@ extern "C"
#endif /* __cplusplus */ #endif /* __cplusplus */
/** Retrieve the release number of the currently running PortAudio build. /** Retrieve the release number of the currently running PortAudio build.
* For example, for version "19.5.1" this will return 0x00130501. For example, for version "19.5.1" this will return 0x00130501.
@see paMakeVersionNumber
*/ */
int Pa_GetVersion( void ); int Pa_GetVersion( void );
/** Retrieve a textual description of the current PortAudio build, /** Retrieve a textual description of the current PortAudio build,
* e.g. "PortAudio V19.5.0-devel, revision 1952M". e.g. "PortAudio V19.5.0-devel, revision 1952M".
* The format of the text may change in the future. Do not try to parse the The format of the text may change in the future. Do not try to parse the
* returned string. returned string.
* @deprecated use PaVersionInfo() instead
@deprecated As of 19.5.0, use Pa_GetVersionInfo()->versionText instead.
*/ */
const char* Pa_GetVersionText( void ); const char* Pa_GetVersionText( void );
/** /**
* Generate a packed integer version number in the same format used Generate a packed integer version number in the same format used
* by Pa_GetVersion(). Use this to compare a specified version number with by Pa_GetVersion(). Use this to compare a specified version number with
* the currently running version. For example: the currently running version. For example:
*
* if( Pa_GetVersion() < paMakeVersionNumber(19,5,1) ) {} @code
if( Pa_GetVersion() < paMakeVersionNumber(19,5,1) ) {}
@endcode
@see Pa_GetVersion, Pa_GetVersionInfo
@version Available as of 19.5.0.
*/ */
#define paMakeVersionNumber(major, minor, subminor) \ #define paMakeVersionNumber(major, minor, subminor) \
(((major)&0xFF)<<16 | ((minor)&0xFF)<<8 | ((subminor)&0xFF)) (((major)&0xFF)<<16 | ((minor)&0xFF)<<8 | ((subminor)&0xFF))
/** /**
* A structure containing the components of the version numbers. A structure containing PortAudio API version information.
@see Pa_GetVersionInfo, paMakeVersionNumber
@version Available as of 19.5.0.
*/ */
typedef struct PaVersionInfo { typedef struct PaVersionInfo {
int versionMajor; int versionMajor;
int versionMinor; int versionMinor;
int versionSubMinor; int versionSubMinor;
/** /**
* This is currently the Git revision hash but may change in the future. This is currently the Git revision hash but may change in the future.
* The versionControlRevision is updated by running a script before compiling the library. The versionControlRevision is updated by running a script before compiling the library.
* If the update does not occur, this value may refer to an earlier revision. If the update does not occur, this value may refer to an earlier revision.
*/ */
const char *versionControlRevision; const char *versionControlRevision;
/** Version as a string, for example "PortAudio V19.5.0-devel, revision 1952M" */ /** Version as a string, for example "PortAudio V19.5.0-devel, revision 1952M" */
const char *versionText; const char *versionText;
} PaVersionInfo; } PaVersionInfo;
/** /** Retrieve version information for the currently running PortAudio build.
* The structure that this points to is statically allocated. @return A pointer to an immutable PaVersionInfo structure.
* Do not attempt to free it or modify it.
@note This function can be called at any time. It does not require PortAudio
to be initialized. The structure pointed to is statically allocated. Do not
attempt to free it or modify it.
@see PaVersionInfo, paMakeVersionNumber
@version Available as of 19.5.0.
*/ */
const PaVersionInfo* Pa_GetVersionInfo(); const PaVersionInfo* Pa_GetVersionInfo();
/** Error codes returned by PortAudio functions. /** Error codes returned by PortAudio functions.
Note that with the exception of paNoError, all PaErrorCodes are negative. Note that with the exception of paNoError, all PaErrorCodes are negative.
*/ */