include: fix apidoc warnings about undocumented parameters

canonical · Oct 10, 2024 · cfac5eb · cfac5eb
1 parent 8820231
commit cfac5eb
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/include/netdef.h b/include/netdef.h
@@ -54,15 +54,15 @@ netplan_netdef_get_filepath(const NetplanNetDefinition* netdef, char* out_buffer
 
 /**
  * @brief Get the specific @ref NetplanBackend defined for this @ref NetplanNetDefinition.
- * @param[in] np_state The @ref NetplanState to query
+ * @param[in] netdef   The @ref NetplanNetDefinition to query
  * @return             Enumeration value, specifiying the @ref NetplanBackend
  */
 NETPLAN_PUBLIC NetplanBackend
 netplan_netdef_get_backend(const NetplanNetDefinition* netdef);
 
 /**
  * @brief Get the interface type for a given @ref NetplanNetDefinition.
- * @param[in] np_state The @ref NetplanState to query
+ * @param[in] netdef   The @ref NetplanNetDefinition to query
  * @return             Enumeration value of @ref NetplanDefType, specifiying the interface type
  */
 NETPLAN_PUBLIC NetplanDefType

diff --git a/include/state.h b/include/state.h
@@ -124,10 +124,10 @@ netplan_state_update_yaml_hierarchy(
 /**
  * @brief   Dump the whole @ref NetplanState into a single YAML file.
  * @details Ignoring the origin of each @ref NetplanNetDefinition.
- * @param[in]  np_state The @ref NetplanState for which to generate the configuration
- * @param[in]  out_fd   File descriptor to an opened file into which to dump the content
- * @param[out] error    Filled with a @ref NetplanError in case of failure
- * @return              Indication of success or failure
+ * @param[in]  np_state  The @ref NetplanState for which to generate the configuration
+ * @param[in]  output_fd File descriptor to an opened file into which to dump the content
+ * @param[out] error     Filled with a @ref NetplanError in case of failure
+ * @return               Indication of success or failure
  */
 NETPLAN_PUBLIC gboolean
 netplan_state_dump_yaml(

diff --git a/include/types.h b/include/types.h
@@ -106,7 +106,7 @@ typedef struct _NetplanStateIterator NetplanStateIterator;
  * @note    The idea is based on the GLib implementation of iterators.
  */
 struct _NetplanStateIterator {
-    void* placeholder;
+    void* placeholder; ///< Just a placeholder in memory
 };
 
 /*