github-starred/libxlsxwriter
2
0
Fork 0
mirror of https://github.com/jmcnamara/libxlsxwriter.git synced 2026-05-15 14:15:54 -06:00
Code Issues 16 Projects Packages Wiki Activity Actions

Add docs for lxw_version().

Browse source
This commit is contained in:
John McNamara 2018-09-01 16:41:51 +01:00
parent 157feee33f
commit b74f48c6f1
4 changed files with 17 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -24,7 +24,7 @@ the `xlsxwriter.h` header file or by adding the following to your program:
int main() {
printf("Libxlsxwriter version = %s\n", LXW_VERSION);
printf("Libxlsxwriter version = %s\n", lxw_version());
return 0;
}

2
docs/src/bugs.dox
View file

@ -89,7 +89,7 @@ and running the following program:
int main() {
printf("Libxlsxwriter version = %s\n", LXW_VERSION);
printf("Libxlsxwriter version = %s\n", lxw_version());
return 0;
}

1
docs/src/mainpage.dox
View file

@ -46,6 +46,7 @@ following sections for more information:
- @ref worksheet.h "The Worksheet object"
- @ref format.h "The Format object"
- @ref chart.h "The Chart object"
- @ref utility.h "Utility functions and macros"
- @ref working_with_formats
- @ref working_with_colors

20
include/xlsxwriter/utility.h
View file

@ -86,6 +86,20 @@ extern "C" {
#endif
/* *INDENT-ON* */
/**
* @brief Retrieve the library version.
*
* @return The "X.Y.Z" version string.
*
* Get the library version as a "X.Y.Z" version string
*
* @code
* printf("Libxlsxwriter version = %s\n", lxw_version());
* @endcode
*
*/
const char *lxw_version(void);
/**
* @brief Converts a libxlsxwriter error number to a string.
*
@ -163,12 +177,6 @@ int lxw_sprintf_dbl(char *data, double number);
lxw_snprintf(data, LXW_ATTR_32, "%.16g", number)
#endif
/**
* @brief Retrieve runtime library version
*
* @return A pointer to a statically allocated string. Do not free.
*/
const char *lxw_version(void);
/* *INDENT-OFF* */
#ifdef __cplusplus