Revision 334
added more docs
| xpm_utils.h | ||
|---|---|---|
| 1 | 1 |
#ifndef XMP_UTILS_H_INCLUDED |
| 2 | 2 |
#define XMP_UTILS_H_INCLUDED |
| 3 | 3 |
|
| 4 |
/** |
|
| 5 |
* @defgroup xpm_utils xpm_utils |
|
| 6 |
* @ingroup utils |
|
| 7 |
* @brief XPM utilities module. |
|
| 8 |
* |
|
| 9 |
* @{
|
|
| 10 |
*/ |
|
| 11 |
|
|
| 12 |
/** |
|
| 13 |
* @brief Save XPM array of strings as a XPM2 text file. |
|
| 14 |
* @param p XPM to be saved |
|
| 15 |
* @param s Path to save the XPM as XPM2 file |
|
| 16 |
*/ |
|
| 4 | 17 |
void xpm_save_as_xpm2(const char* const* p, const char *s); |
| 5 |
|
|
| 18 |
/** |
|
| 19 |
* @brief Load XPM2 file as a XPM array of strings. |
|
| 20 |
* @param s Path to XPM2 file to be loaded |
|
| 21 |
* @return Array of strings representing the loaded XPM |
|
| 22 |
*/ |
|
| 6 | 23 |
char** xpm_load_xpm2(const char *s); |
| 7 | 24 |
|
| 25 |
/** |
|
| 26 |
* @} |
|
| 27 |
*/ |
|
| 28 |
|
|
| 8 | 29 |
#endif //XMP_UTILS_H_INCLUDED |
Also available in: Unified diff