[sr-dev] git:master:0999f108: core: add doxygen file header to current memory manager

[Henning Westerholt]

Module: kamailio
Branch: master
Commit: 0999f108c91bdcfed91878241345fb24da3fc2a7
URL: https://github.com/kamailio/kamailio/commit/0999f108c91bdcfed91878241345fb24da3fc2a7

Author: Henning Westerholt <hw at kamailio.org>
Committer: Henning Westerholt <hw at kamailio.org>
Date: 2018-12-26T21:12:42+01:00

core: add doxygen file header to current memory manager

---

Modified: src/core/mem/pkg.c
Modified: src/core/mem/pkg.h
Modified: src/core/mem/shm.c
Modified: src/core/mem/shm.h

---

Diff:  https://github.com/kamailio/kamailio/commit/0999f108c91bdcfed91878241345fb24da3fc2a7.diff
Patch: https://github.com/kamailio/kamailio/commit/0999f108c91bdcfed91878241345fb24da3fc2a7.patch

---

diff --git a/src/core/mem/pkg.c b/src/core/mem/pkg.c
index f1e616eca6..57d7ea051d 100644
--- a/src/core/mem/pkg.c
+++ b/src/core/mem/pkg.c
@@ -16,6 +16,13 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * \file
+ * \brief Main definitions for memory manager
+ * 
+ * Main definitions for PKG memory manager, like malloc, free and realloc
+ * \ingroup mem
+ */
 
 #include <string.h>
 #include <stdlib.h>
diff --git a/src/core/mem/pkg.h b/src/core/mem/pkg.h
index 0fe7f8942c..7b57719e46 100644
--- a/src/core/mem/pkg.h
+++ b/src/core/mem/pkg.h
@@ -16,6 +16,13 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * \file
+ * \brief Main definitions for memory manager
+ * 
+ * Main definitions for PKG memory manager, like malloc, free and realloc
+ * \ingroup mem
+ */
 
 #ifndef _sr_pkg_h_
 #define _sr_pkg_h_
diff --git a/src/core/mem/shm.c b/src/core/mem/shm.c
index 2cecb1110e..b25fef1a51 100644
--- a/src/core/mem/shm.c
+++ b/src/core/mem/shm.c
@@ -16,6 +16,12 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * \file
+ * \brief  Shared memory functions
+ * \ingroup mem
+ */
+
 #include <stdlib.h>
 
 #include "../config.h"
diff --git a/src/core/mem/shm.h b/src/core/mem/shm.h
index e36a94accc..4143462617 100644
--- a/src/core/mem/shm.h
+++ b/src/core/mem/shm.h
@@ -16,6 +16,11 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * \file
+ * \brief  Shared memory functions
+ * \ingroup mem
+ */
 
 #ifndef _sr_shm_h_
 #define _sr_shm_h_