doc FEATURE doxygen documentation created
Can be build using make doc.
diff --git a/src/session_client_ch.h b/src/session_client_ch.h
index 39ccc4f..5f8dab7 100644
--- a/src/session_client_ch.h
+++ b/src/session_client_ch.h
@@ -49,7 +49,7 @@
/**
* @brief Set SSH Call Home password authentication callback.
*
- * @param[in] auth_password Function to call, returns the password for username@hostname.
+ * @param[in] auth_password Function to call, returns the password for username\@hostname.
* If NULL, the default callback is set.
*/
void nc_client_ssh_ch_set_auth_password_clb(char *(*auth_password)(const char *username, const char *hostname));
@@ -95,8 +95,6 @@
*
* Private key can be encrypted, the passphrase will be asked for before using it.
*
- * Function is provided only via nc_client.h header file and only when libnetconf2 is compiled with libssh support.
- *
* @param[in] pub_key Path to the public key.
* @param[in] priv_key Path to the private key.
* @return 0 on success, -1 on error.
@@ -106,8 +104,6 @@
/**
* @brief Remove an SSH public and private key pair that was used for Call Home client authentication.
*
- * Function is provided only via nc_client.h header file and only when libnetconf2 is compiled with libssh support.
- *
* @param[in] idx Index of the keypair starting with 0.
* @return 0 on success, -1 on error.
*/
@@ -133,8 +129,6 @@
/**
* @brief Set SSH Call Home authentication method preference.
*
- * Function is provided only via nc_client.h header file and only when libnetconf2 is compiled with libssh support.
- *
* @param[in] auth_type Authentication method to modify the prefrence of.
* @param[in] pref Preference of \p auth_type. Negative values disable the method.
*/
@@ -143,8 +137,6 @@
/**
* @brief Get SSH Call Home authentication method preference.
*
- * Function is provided only via nc_client.h header file and only when libnetconf2 is compiled with libssh support.
- *
* @param[in] auth_type Authentication method to retrieve the prefrence of.
* @return Preference of the \p auth_type.
*/
@@ -190,8 +182,6 @@
/**
* @brief Set client Call Home authentication identity - a certificate and a private key.
*
- * Function is provided only via nc_client.h header file and only when libnetconf2 is compiled with TLS support.
- *
* @param[in] client_cert Path to the file containing the client certificate.
* @param[in] client_key Path to the file containing the private key for the \p client_cert.
* If NULL, key is expected to be stored with \p client_cert.
@@ -202,8 +192,6 @@
/**
* @brief Get client Call Home authentication identity - a certificate and a private key.
*
- * Function is provided only via nc_client.h header file and only when libnetconf2 is compiled with TLS support.
- *
* @param[out] client_cert Path to the file containing the client certificate. Can be NULL.
* @param[out] client_key Path to the file containing the private key for the \p client_cert.
* Can be NULL.