diff --git a/include/netdef.h b/include/netdef.h index ea9dbd2e3..1fa1748f1 100644 --- a/include/netdef.h +++ b/include/netdef.h @@ -70,7 +70,7 @@ NETPLAN_PUBLIC NetplanDefType netplan_netdef_get_type(const NetplanNetDefinition* netdef); /** - * @brief Get the Netplan ID of a given @ref NetplanNetDefinition. + * @brief Get the Netplan ID of a given @ref NetplanNetDefinition. * @details Copies a `NUL`-terminated string into a sized @p out_buffer. If the * buffer is too small its content will not be `NUL`-terminated. * @param[in] netdef The @ref NetplanNetDefinition to query @@ -143,7 +143,7 @@ netplan_netdef_get_set_name(const NetplanNetDefinition* netdef, char* out_buffer /** * @brief Query a @ref NetplanNetDefinition for a `match` stanza in its configuration. - * @details In the absence of a `match` stanza, the Netplan ID + * @details In the absence of a `match` stanza, the Netplan ID can be considered to be the interface name of a single interface. Otherwise, it could match multiple interfaces. * @param[in] netdef The @ref NetplanNetDefinition to query * @return Indication if @p netdef uses custom interface matching rules diff --git a/include/types.h b/include/types.h index f975f61aa..777ae4987 100644 --- a/include/types.h +++ b/include/types.h @@ -78,7 +78,7 @@ typedef struct netplan_parser NetplanParser; /// See @ref netplan_state_new and related accessor functions. typedef struct netplan_state NetplanState; -/// Private data structure to contain individual settings per Netplan ID. +/// Private data structure to contain individual settings per Netplan ID. /// See @ref netplan_state_get_netdef, @ref netplan_netdef_get_id and related accessor functions. typedef struct netplan_net_definition NetplanNetDefinition; diff --git a/include/util.h b/include/util.h index e604319d0..4b244be2c 100644 --- a/include/util.h +++ b/include/util.h @@ -33,7 +33,7 @@ /** * @brief Parses YAML hierarchy from @p rootdir, drops the configuration for @p id * from the @ref NetplanState and re-generates the YAML files. - * @param[in] id The Netplan ID for a specific configuration block of network interface(s) + * @param[in] id The Netplan ID for a specific configuration block of network interface(s) * @param[in] rootdir If not `NULL`, parse configuration from this root directory (useful for testing) * @return Indication of success or failure */ @@ -41,7 +41,7 @@ NETPLAN_PUBLIC gboolean netplan_delete_connection(const char* id, const char* rootdir); /** - * @brief Extract the Netplan ID from the filepath of a NetworkManager keyfile. + * @brief Extract the Netplan ID from the filepath of a NetworkManager keyfile. * @details Copies a `NUL`-terminated string into a sized @p out_buffer. If the * buffer is too small its content will not be `NUL`-terminated. * @note This can be applied to NetworkManager connection profiles generated by Netplan, following a `netplan-ID[-SSID].nmconnection` naming scheme, as used by the NetworkManager YAML backend.