root
/
xz
mirror of https://git.tukaani.org/xz.git
1
0
Fork 0
Code Issues Releases Wiki Activity

liblzma: Improve documentation for version.h. 

Specified parameter and return values for API functions and documented
a few more of the macros.
This commit is contained in:
Jia Tan 2023-01-26 09:50:21 +08:00
parent 850adec171
commit 912af91b10
1 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/liblzma/api/lzma/version.h
View File

@ -18,14 +18,26 @@
#endif #endif
/* /** \brief Major version number of the liblzma release. */
* Version number split into components
*/
#define LZMA_VERSION_MAJOR 5 #define LZMA_VERSION_MAJOR 5
/** \brief Minor version number of the liblzma release. */
#define LZMA_VERSION_MINOR 5 #define LZMA_VERSION_MINOR 5
/** \brief Patch version number of the liblzma release. */
#define LZMA_VERSION_PATCH 0 #define LZMA_VERSION_PATCH 0
/**
* \brief Version stability marker
*
* This will always be one of three values:
* - LZMA_VERSION_STABILITY_ALPHA
* - LZMA_VERSION_STABILITY_BETA
* - LZMA_VERSION_STABILITY_STABLE
*/
#define LZMA_VERSION_STABILITY LZMA_VERSION_STABILITY_ALPHA #define LZMA_VERSION_STABILITY LZMA_VERSION_STABILITY_ALPHA
/** \brief Commit version number of the liblzma release */
#ifndef LZMA_VERSION_COMMIT #ifndef LZMA_VERSION_COMMIT
# define LZMA_VERSION_COMMIT "" # define LZMA_VERSION_COMMIT ""
#endif #endif
@ -102,9 +114,10 @@
/** /**
* \brief Run-time version number as an integer * \brief Run-time version number as an integer
* *
* Return the value of LZMA_VERSION macro at the compile time of liblzma. * This allows an application to compare if it was built against the same,
* This allows the application to compare if it was built against the same,
* older, or newer version of liblzma that is currently running. * older, or newer version of liblzma that is currently running.
*
* \return The value of LZMA_VERSION macro at the compile time of liblzma
*/ */
extern LZMA_API(uint32_t) lzma_version_number(void) extern LZMA_API(uint32_t) lzma_version_number(void)
lzma_nothrow lzma_attr_const; lzma_nothrow lzma_attr_const;
@ -113,8 +126,10 @@ extern LZMA_API(uint32_t) lzma_version_number(void)
/** /**
* \brief Run-time version as a string * \brief Run-time version as a string
* *
* This function may be useful if you want to display which version of * This function may be useful to display which version of liblzma an
* liblzma your application is currently using. * application is currently using.
*
* \return Run-time version of liblzma
*/ */
extern LZMA_API(const char *) lzma_version_string(void) extern LZMA_API(const char *) lzma_version_string(void)
lzma_nothrow lzma_attr_const; lzma_nothrow lzma_attr_const;