Skip to content

Commit

Permalink
docs: fix linkcheck
Browse files Browse the repository at this point in the history
  • Loading branch information
slyon committed Jan 24, 2024
1 parent f576cca commit a729c5c
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions include/netdef.h
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ NETPLAN_PUBLIC NetplanDefType
netplan_netdef_get_type(const NetplanNetDefinition* netdef);

/**
* @brief Get the <a href="/structure-id/#device-configuration-ids">Netplan ID</a> 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
Expand Down Expand Up @@ -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 <a href="/structure-id/#device-configuration-ids">Netplan ID</a>
* @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
Expand Down
2 changes: 1 addition & 1 deletion include/types.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="/structure-id/#device-configuration-ids">Netplan ID</a>.
/// 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;

Expand Down
4 changes: 2 additions & 2 deletions include/util.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@
/**
* @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 <a href="/structure-id/#device-configuration-ids">Netplan ID</a> 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
*/
NETPLAN_PUBLIC gboolean
netplan_delete_connection(const char* id, const char* rootdir);

/**
* @brief Extract the <a href="/structure-id/#device-configuration-ids">Netplan ID</a> 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.
Expand Down

0 comments on commit a729c5c

Please sign in to comment.