Updated docs and todo.

FedeDP · Nov 23, 2018 · 8553722 · 8553722
1 parent 2879553
commit 8553722
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/TODO.md b/TODO.md
@@ -6,6 +6,8 @@
 - [x] Store context name in m_context (strdup'd)
 - [x] Use them as hashmap key without strudpping again
 
+- [ ] Remove cycle between self and module: module shouldn't have a pointer to self.
+
 ### Api improvements
 - [x] Add new MOD_NO_MEM error code
 - [x] Add new MOD_WRONG_PARAM error code

diff --git a/docs/src/data_structures.rst b/docs/src/data_structures.rst
@@ -87,7 +87,9 @@ Return Codes
 .. code::
 
     typedef enum {
-        MOD_WRONG_STATE = -6,
+        MOD_WRONG_PARAM = -8,
+        MOD_NO_MEM,
+        MOD_WRONG_STATE,
         MOD_NO_PARENT,
         MOD_NO_CTX,
         MOD_NO_MOD,

diff --git a/docs/src/map.rst b/docs/src/map.rst
@@ -14,7 +14,8 @@ Map structures
 .. code::
 
     typedef enum {
-        MAP_ERR = -4,
+        MAP_WRONG_PARAM = -5,
+        MAP_ERR,
         MAP_MISSING,
         MAP_FULL,
         MAP_OMEM,
@@ -70,7 +71,7 @@ Where not specified, these functions return a map_ret_code.
   :param key: key for this value
   :type m: :c:type:`map_t *`
   :type key: :c:type:`const char *`
-  :returns: void pointer to value.
+  :returns: void pointer to value, on NULL on error.
 
 .. c:function:: map_has_key(m, key)