update/extend doxygen documentation
It's a pity that even with this patch we still are fare away from having
the whole API documented. However, at least we have a more solid
foundation. Updates not only extend the documentation, but also make
sure it is rendered properly in the doxygen HTML.
Change-Id: I1344bd1a6869fb00de7c1899a8db93bba9bafce3
diff --git a/src/gsm/gsm0341.c b/src/gsm/gsm0341.c
index 1c14d3e..2592b54 100644
--- a/src/gsm/gsm0341.c
+++ b/src/gsm/gsm0341.c
@@ -27,6 +27,22 @@
#include <osmocom/core/talloc.h>
#include <osmocom/gsm/protocol/gsm_03_41.h>
+/*! \addtogroup sms
+ * @{
+ */
+
+/*! \brief Encode a 3GPP TS 03.41 SMS-CB message
+ * \param[in] ctx talloc allocation context
+ * \param[in] geo_scope Geographic Scope
+ * \param[in] msg_code Message Code
+ * \param[in] update Is this an update?
+ * \param[in] msg_id Message ID
+ * \param[in] dcs Data Coding Scheme
+ * \param[in] page_total Total number of pages
+ * \param[in] page_cur Current Page (up to \a page_total)
+ * \param[in] data Message data (copied 1:1)
+ * \param[in] len Length of \a data in bytes (up to 88)
+ * \returns callee-allocated TS 03.41 message with encoded data */
struct gsm341_ms_message *
gsm0341_build_msg(void *ctx, uint8_t geo_scope, uint8_t msg_code,
uint8_t update, uint16_t msg_id, uint8_t dcs,
@@ -57,3 +73,5 @@
return cbmsg;
}
+
+/*! @} */