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

updated doc comments to reflect that versionControlRevision is now a git revision hash

Browse source
This commit is contained in:
Ross Bencina 2016-09-23 21:10:21 +10:00
commit c2326aa8f0
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
include/portaudio.h
View file

@ -56,8 +56,9 @@ extern "C"
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,
* eg "PortAudio V19.5.0-devel, revision 1952M". * e.g. "PortAudio V19.5.0-devel, revision 1952M".
* The format of the text may change so do not try to parse the returned string. * The format of the text may change in the future. Do not try to parse the
* returned string.
* @deprecated use PaVersionInfo() instead * @deprecated use PaVersionInfo() instead
*/ */
const char* Pa_GetVersionText( void ); const char* Pa_GetVersionText( void );
@ -67,7 +68,7 @@ const char* Pa_GetVersionText( void );
* 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)) {} * if( Pa_GetVersion() < paMakeVersionNumber(19,5,1) ) {}
*/ */
#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))
@ -81,10 +82,9 @@ typedef struct PaVersionInfo {
int versionMinor; int versionMinor;
int versionSubMinor; int versionSubMinor;
/** /**
* This is currently the SVN revision 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 code. * The versionControlRevision is updated by running a script before compiling the library.
* If the update does not occur then this value may be less * If the update does not occur, this value may refer to an earlier revision.
* than the actual SVN revision number.
*/ */
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" */