diff options
Diffstat (limited to 'cmake/templates/api.desc.cmake')
| -rw-r--r-- | cmake/templates/api.desc.cmake | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/cmake/templates/api.desc.cmake b/cmake/templates/api.desc.cmake new file mode 100644 index 0000000..d895ba8 --- /dev/null +++ b/cmake/templates/api.desc.cmake @@ -0,0 +1,22 @@ +/** + * \mainpage Gammu API + * \version @GAMMU_VERSION@ + * \author Michal Čihař + * + * \b Gammu is library for communicating with (mostly) GSM phones. + * You can interface to it by creating \ref GSM_StateMachine and then + * using various functions on it. + * + * If you want to interact with SMS daemon, set of functions is provided + * in \ref SMSD submodule. + * + * This documentation is still not complete, however we try to complete + * documentation to every code part we touch. If you don't userstand + * something, please don't hesitate to ask on mailing list + * gammu-users@lists.sourceforge.net. + * + * \if VIMFakeDefine + * vim: ft=c smartindent: + * vim: noexpandtab sw=8 ts=8 sts=8 tw=72: + * \endif + */ |