add missing doxygen commands, fix typo

This commit is contained in:
B. Petersen
2019-09-19 11:41:27 +02:00
parent 37f854be3e
commit d338748115

View File

@@ -443,6 +443,8 @@ char* dc_get_info (dc_context_t* context);
char* dc_get_oauth2_url (dc_context_t* context, const char* addr, const char* redirect_uri); char* dc_get_oauth2_url (dc_context_t* context, const char* addr, const char* redirect_uri);
/** /**
* @class dc_provider_t
*
* Opaque object containing information about one single email provider. * Opaque object containing information about one single email provider.
*/ */
typedef struct _dc_provider dc_provider_t; typedef struct _dc_provider dc_provider_t;
@@ -450,7 +452,8 @@ typedef struct _dc_provider dc_provider_t;
/** /**
* Create a provider struct for the given domain. * Create a provider struct for the given domain.
* *
* @param doamin The domain to get provider info for. * @memberof dc_provider_t
* @param domain The domain to get provider info for.
* @return a dc_provider_t struct which can be used with the dc_provider_get_* * @return a dc_provider_t struct which can be used with the dc_provider_get_*
* accessor functions. If no provider info is found, NULL will be * accessor functions. If no provider info is found, NULL will be
* returned. * returned.
@@ -462,6 +465,7 @@ dc_provider_t* dc_provider_new_from_domain (char* domain);
* *
* The provider is extracted from the email address and it's information is returned. * The provider is extracted from the email address and it's information is returned.
* *
* @memberof dc_provider_t
* @param email The user's email address to extract the provider info form. * @param email The user's email address to extract the provider info form.
* @return a dc_provider_t struct which can be used with the dc_provider_get_* * @return a dc_provider_t struct which can be used with the dc_provider_get_*
* accessor functions. If no provider info is found, NULL will be * accessor functions. If no provider info is found, NULL will be
@@ -474,6 +478,7 @@ dc_provider_t* dc_provider_new_from_email (char* email);
* *
* This URL allows linking to the providers page on providers.delta.chat. * This URL allows linking to the providers page on providers.delta.chat.
* *
* @memberof dc_provider_t
* @param provider The dc_provider_t struct. * @param provider The dc_provider_t struct.
* @return A string which must be free()d. * @return A string which must be free()d.
*/ */
@@ -484,6 +489,7 @@ char* dc_provider_get_overview_page (const dc_provider_t* prov
* *
* The name of the provider, e.g. "POSTEO". * The name of the provider, e.g. "POSTEO".
* *
* @memberof dc_provider_t
* @param provider The dc_provider_t struct. * @param provider The dc_provider_t struct.
* @return A string which must be free()d. * @return A string which must be free()d.
*/ */
@@ -493,8 +499,9 @@ char* dc_provider_get_name (const dc_provider_t* prov
* The markdown content of the providers page. * The markdown content of the providers page.
* *
* This contains the preparation steps or additional information if the status * This contains the preparation steps or additional information if the status
* is DC_PROVIDER_STATUS_BROKEN. * is @ref DC_PROVIDER_STATUS_BROKEN.
* *
* @memberof dc_provider_t
* @param provider The dc_provider_t struct. * @param provider The dc_provider_t struct.
* @return A string which must be free()d. * @return A string which must be free()d.
*/ */
@@ -505,6 +512,7 @@ char* dc_provider_get_markdown (const dc_provider_t* prov
* *
* This is returned as a string. * This is returned as a string.
* *
* @memberof dc_provider_t
* @param provider The dc_provider_t struct. * @param provider The dc_provider_t struct.
* @return A string which must be free()d. * @return A string which must be free()d.
*/ */
@@ -516,6 +524,7 @@ char* dc_provider_get_status_date (const dc_provider_t* prov
* Can be one of @ref DC_PROVIDER_STATUS_OK, @ref * Can be one of @ref DC_PROVIDER_STATUS_OK, @ref
* DC_PROVIDER_STATUS_PREPARATION and @ref DC_PROVIDER_STATUS_BROKEN. * DC_PROVIDER_STATUS_PREPARATION and @ref DC_PROVIDER_STATUS_BROKEN.
* *
* @memberof dc_provider_t
* @param provider The dc_provider_t struct. * @param provider The dc_provider_t struct.
* @return The status as a constant number. * @return The status as a constant number.
*/ */
@@ -524,10 +533,21 @@ int dc_provider_get_status (const dc_provider_t* prov
/** /**
* Free the provider info struct. * Free the provider info struct.
* *
* @memberof dc_provider_t
* @param provider The dc_provider_t struct. * @param provider The dc_provider_t struct.
*/ */
void dc_provider_unref (const dc_provider_t* provider); void dc_provider_unref (const dc_provider_t* provider);
/**
* @defgroup DC_PROVIDER_STATUS DC_PROVIDER_STATUS
*
* These constants are used as return values for dc_provider_get_status().
*
* @addtogroup DC_PROVIDER_STATUS
* @{
*/
/** /**
* Provider status returned by dc_provider_get_status(). * Provider status returned by dc_provider_get_status().
* *
@@ -549,6 +569,11 @@ void dc_provider_unref (const dc_provider_t* prov
*/ */
#define DC_PROVIDER_STATUS_BROKEN 3 #define DC_PROVIDER_STATUS_BROKEN 3
/**
* @}
*/
// connect // connect
/** /**