Skip to content
Snippets Groups Projects
Verified Commit 94a49b8b authored by Timm Fitschen's avatar Timm Fitschen
Browse files

DOC: add EXPORT USE ONLY hints to some c-interface functions

parent 3ab9959b
No related branches found
No related tags found
1 merge request!1Minimal c interface
Pipeline #10589 passed
Pipeline: caosdb-cppinttest

#10590

    ......@@ -91,12 +91,17 @@ const char *caosdb_utility_get_env_var(const char *name, const char *fall_back);
    * Use the destructor function
    * `caosdb_connection_delete_certificate_provider` to free the wrapped
    * provider.
    *
    * EXPERT USE ONLY. Memory management with this function is a bit tricky.
    * Only use it when you know what you are doing.
    */
    int caosdb_connection_create_pem_file_certificate_provider(
    caosdb_connection_certificate_provider *out, const char *path);
    /**
    * Destructor function for a certificate provider.
    *
    * EXPERT USE ONLY. Only use it when you know what you are doing.
    */
    int caosdb_connection_delete_certificate_provider(
    caosdb_connection_certificate_provider *provider);
    ......@@ -109,6 +114,9 @@ int caosdb_connection_delete_certificate_provider(
    * Use the destructor function
    * `caosdb_connection_delete_connection_configuration` to free the wrapped
    * configuration.
    *
    * EXPERT USE ONLY. Memory management with this function is a bit tricky.
    * Only use it when you know what you are doing.
    */
    int caosdb_connection_create_tls_connection_configuration(
    caosdb_connection_connection_configuration *out, const char *host,
    ......@@ -126,6 +134,9 @@ int caosdb_connection_create_tls_connection_configuration(
    * Use the destructor function
    * `caosdb_connection_delete_connection_configuration` to free the wrapped
    * configuration.
    *
    * EXPERT USE ONLY. Memory management with this function is a bit tricky.
    * Only use it when you know what you are doing.
    */
    int caosdb_connection_create_insecure_connection_configuration(
    caosdb_connection_connection_configuration *out, const char *host,
    ......@@ -134,6 +145,8 @@ int caosdb_connection_create_insecure_connection_configuration(
    /**
    * Destructor function for the caosdb_connection_connection_configuration
    * struct.
    *
    * EXPERT USE ONLY. Only use it when you know what you are doing.
    */
    int caosdb_connection_delete_connection_configuration(
    caosdb_connection_connection_configuration *configuration);
    ......@@ -154,6 +167,9 @@ int caosdb_connection_configuration_add_cacert(
    * Use the destructor function
    * `caosdb_authentication_delete_authenticator` to free the wrapped
    * authenticator.
    *
    * EXPERT USE ONLY. Memory management with this function is a bit tricky.
    * Only use it when you know what you are doing.
    */
    int caosdb_authentication_create_plain_password_authenticator(
    caosdb_authentication_authenticator *out, const char *username,
    ......@@ -161,6 +177,8 @@ int caosdb_authentication_create_plain_password_authenticator(
    /**
    * Destructor function for the caosdb_authentication_authenticator struct.
    *
    * EXPERT USE ONLY. Only use it when you know what you are doing.
    */
    int caosdb_authentication_delete_authenticator(
    caosdb_authentication_authenticator *authenticator);
    ......@@ -174,6 +192,9 @@ int caosdb_authentication_delete_authenticator(
    * Use the destructor function
    * `caosdb_connection_delete_connection` to free the wrapped
    * connection.
    *
    * EXPERT USE ONLY. Memory management with this function is a bit tricky.
    * Only use it when you know what you are doing.
    */
    int caosdb_connection_create_connection(
    caosdb_connection_connection *out,
    ......@@ -181,6 +202,8 @@ int caosdb_connection_create_connection(
    /**
    * Destructor function for the caosdb_connection_connection struct.
    *
    * EXPERT USE ONLY. Only use it when you know what you are doing.
    */
    int caosdb_connection_delete_connection(
    caosdb_connection_connection *connection);
    ......
    0% Loading or .
    You are about to add 0 people to the discussion. Proceed with caution.
    Finish editing this message first!
    Please register or to comment