Skip to content

Commit 8553722

Browse files
committed
Updated docs and todo.
1 parent 2879553 commit 8553722

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

TODO.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
- [x] Store context name in m_context (strdup'd)
77
- [x] Use them as hashmap key without strudpping again
88

9+
- [ ] Remove cycle between self and module: module shouldn't have a pointer to self.
10+
911
### Api improvements
1012
- [x] Add new MOD_NO_MEM error code
1113
- [x] Add new MOD_WRONG_PARAM error code

docs/src/data_structures.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,9 @@ Return Codes
8787
.. code::
8888
8989
typedef enum {
90-
MOD_WRONG_STATE = -6,
90+
MOD_WRONG_PARAM = -8,
91+
MOD_NO_MEM,
92+
MOD_WRONG_STATE,
9193
MOD_NO_PARENT,
9294
MOD_NO_CTX,
9395
MOD_NO_MOD,

docs/src/map.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Map structures
1414
.. code::
1515
1616
typedef enum {
17-
MAP_ERR = -4,
17+
MAP_WRONG_PARAM = -5,
18+
MAP_ERR,
1819
MAP_MISSING,
1920
MAP_FULL,
2021
MAP_OMEM,
@@ -70,7 +71,7 @@ Where not specified, these functions return a map_ret_code.
7071
:param key: key for this value
7172
:type m: :c:type:`map_t *`
7273
:type key: :c:type:`const char *`
73-
:returns: void pointer to value.
74+
:returns: void pointer to value, on NULL on error.
7475

7576
.. c:function:: map_has_key(m, key)
7677

0 commit comments

Comments
 (0)