summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJo-Philipp Wich <jo@mein.io>2025-02-20 12:15:21 +0100
committerJo-Philipp Wich <jo@mein.io>2025-02-20 12:15:21 +0100
commitdf5a79a04b17d7b4fdfd9e72c3193f36bfc95d98 (patch)
tree2b52d8f24c4617ca089e6cd421c5b42270a4d2ac
parent338aa2ebf00e370c7b17c9c022571f2fbc858007 (diff)
uci: link save() and commit() functions in cursor class description
In order to make the nested uci.cursor class description easier to discover, turn the mentioned `save()` and `commit()` functions into proper links pointing into the cursor class documentation. Ref: #277 Signed-off-by: Jo-Philipp Wich <jo@mein.io>
-rw-r--r--lib/uci.c7
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/uci.c b/lib/uci.c
index 3dd86dc..acd89f8 100644
--- a/lib/uci.c
+++ b/lib/uci.c
@@ -196,7 +196,8 @@ uc_uci_cursor(uc_vm_t *vm, size_t nargs)
*
* Any changes made to configuration values are local to the cursor object and
* held in memory only until they're written out to the filesystem using the
- * `save()` and `commit()` methods.
+ * {@link module:uci.cursor#save|save()} and
+ * {@link module:uci.cursor#commit|commit()} methods.
*
* Changes performed in one cursor instance are not reflected in another, unless
* the first instance writes those changes to the filesystem and the other
@@ -1230,8 +1231,8 @@ uc_uci_list_append(uc_vm_t *vm, size_t nargs)
*
* Returns `true` if the item was successfully removed from the list.
*
- * Returns `null` on error, e.g. if the targeted option was not found,
- * the specified value didn't exist in the list, or if an invalid value was passed.
+ * Returns `null` on error, e.g. if the targeted option was not foundor if an
+ * invalid value was passed.
*
* @function module:uci.cursor#list_remove
*