Skip to content

Commit

Permalink
doc UPDATE add correct links to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
roman committed Aug 7, 2023
1 parent 9f254e2 commit a0176aa
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions src/messages_server.h
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ struct nc_server_reply *nc_server_reply_data(struct lyd_node *data, NC_WD_MODE w
/**
* @brief Create an ERROR rpc-reply object.
*
* @param[in] err Errors created by ::nc_err(). It will be freed with the returned object.
* @param[in] err Errors created by nc_err(). It will be freed with the returned object.
* @return rpc-reply object, NULL on error.
*/
struct nc_server_reply *nc_server_reply_err(struct lyd_node *err);
Expand All @@ -118,7 +118,7 @@ struct nc_server_reply *nc_server_reply_err(struct lyd_node *err);
* @brief Add another error opaque data node tree to an ERROR rpc-reply object.
*
* @param[in] reply ERROR reply to add to.
* @param[in] err Error created by ::nc_err(). It will be freed with the returned object.
* @param[in] err Error created by nc_err(). It will be freed with the returned object.
* @return 0 on success, -1 on errror.
*/
int nc_server_reply_add_err(struct nc_server_reply *reply, struct lyd_node *err);
Expand Down
16 changes: 8 additions & 8 deletions src/server_config.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ extern "C" {
* Expected data are a validated instance of a ietf-netconf-server YANG data.
* The data must be in the diff format and supported operations are: create, replace,
* delete and none. Context must already have implemented the required modules, see
* ::nc_config_load_modules().
* ::nc_server_config_load_modules().
*
* @param[in] diff ietf-netconf-server YANG diff data.
* @return 0 on success, 1 on error.
Expand All @@ -54,8 +54,8 @@ int nc_server_config_setup_diff(const struct lyd_node *diff);
* Expected data is a validated instance of a ietf-netconf-server YANG data.
* Behaves as if all the nodes in data had the replace operation. That means that the current configuration will be deleted
* and just the given data will all be applied.
* The data must not contain any operation attribute, see ::nc_config_setup_diff() which works with diff.
* Context must already have implemented the required modules, see * ::nc_config_load_modules().
* The data must not contain any operation attribute, see ::nc_server_config_setup_diff() which works with diff.
* Context must already have implemented the required modules, see ::nc_server_config_load_modules().
*
* @param[in] data ietf-netconf-server YANG data.
* @return 0 on success, 1 on error.
Expand All @@ -64,7 +64,7 @@ int nc_server_config_setup_data(const struct lyd_node *data);

/**
* @brief Configure server based on the given ietf-netconf-server YANG data.
* Wrapper around ::nc_config_setup_server_data() hiding work with parsing the data.
* Wrapper around ::nc_server_config_setup_data() hiding work with parsing the data.
*
* @param[in] ctx libyang context.
* @param[in] path Path to the file with YANG data in XML format.
Expand Down Expand Up @@ -435,8 +435,8 @@ int nc_server_config_new_ssh_del_user_none(const char *endpt_name, const char *u
* @param[in] user_name Arbitrary identifier of the user.
* If an user with this identifier already exists, its contents will be changed.
* @param[in] pam_config_name Name of the PAM configuration file.
* @param[in] pam_config_name Optional. The absolute path to the directory in which the configuration file
* with the name conf_name is located. A newer version (>= 1.4) of PAM library is required to be able to specify
* @param[in] pam_config_dir Optional. The absolute path to the directory in which the configuration file
* with the name pam_config_name is located. A newer version (>= 1.4) of PAM library is required to be able to specify
* the path. If NULL is passed, then the PAM's system directories will be searched (usually /etc/pam.d/).
* @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created.
* Otherwise the new YANG data will be added to the previous data and may override it.
Expand Down Expand Up @@ -1365,8 +1365,8 @@ int nc_server_config_new_ch_ssh_del_user_none(const char *client_name, const cha
* @param[in] user_name Arbitrary identifier of the endpoint's user.
* If the endpoint's user with this identifier already exists, its contents will be changed.
* @param[in] pam_config_name Name of the PAM configuration file.
* @param[in] pam_config_name Optional. The absolute path to the directory in which the configuration file
* with the name conf_name is located. A newer version (>= 1.4) of PAM library is required to be able to specify
* @param[in] pam_config_dir Optional. The absolute path to the directory in which the configuration file
* with the name pam_config_name is located. A newer version (>= 1.4) of PAM library is required to be able to specify
* the path. If NULL is passed, then the PAM's system directories will be searched (usually /etc/pam.d/).
* @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created.
* Otherwise the new YANG data will be added to the previous data and may override it.
Expand Down

0 comments on commit a0176aa

Please sign in to comment.