Skip to content

Commit cfac5eb

Browse files
committed
include: fix apidoc warnings about undocumented parameters
1 parent 8820231 commit cfac5eb

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

include/netdef.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,15 @@ netplan_netdef_get_filepath(const NetplanNetDefinition* netdef, char* out_buffer
5454

5555
/**
5656
* @brief Get the specific @ref NetplanBackend defined for this @ref NetplanNetDefinition.
57-
* @param[in] np_state The @ref NetplanState to query
57+
* @param[in] netdef The @ref NetplanNetDefinition to query
5858
* @return Enumeration value, specifiying the @ref NetplanBackend
5959
*/
6060
NETPLAN_PUBLIC NetplanBackend
6161
netplan_netdef_get_backend(const NetplanNetDefinition* netdef);
6262

6363
/**
6464
* @brief Get the interface type for a given @ref NetplanNetDefinition.
65-
* @param[in] np_state The @ref NetplanState to query
65+
* @param[in] netdef The @ref NetplanNetDefinition to query
6666
* @return Enumeration value of @ref NetplanDefType, specifiying the interface type
6767
*/
6868
NETPLAN_PUBLIC NetplanDefType

include/state.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,10 @@ netplan_state_update_yaml_hierarchy(
124124
/**
125125
* @brief Dump the whole @ref NetplanState into a single YAML file.
126126
* @details Ignoring the origin of each @ref NetplanNetDefinition.
127-
* @param[in] np_state The @ref NetplanState for which to generate the configuration
128-
* @param[in] out_fd File descriptor to an opened file into which to dump the content
129-
* @param[out] error Filled with a @ref NetplanError in case of failure
130-
* @return Indication of success or failure
127+
* @param[in] np_state The @ref NetplanState for which to generate the configuration
128+
* @param[in] output_fd File descriptor to an opened file into which to dump the content
129+
* @param[out] error Filled with a @ref NetplanError in case of failure
130+
* @return Indication of success or failure
131131
*/
132132
NETPLAN_PUBLIC gboolean
133133
netplan_state_dump_yaml(

include/types.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ typedef struct _NetplanStateIterator NetplanStateIterator;
106106
* @note The idea is based on the GLib implementation of iterators.
107107
*/
108108
struct _NetplanStateIterator {
109-
void* placeholder;
109+
void* placeholder; ///< Just a placeholder in memory
110110
};
111111

112112
/*

0 commit comments

Comments
 (0)