pidgin/pidgin

Add some missed docs for PidginCredential*

2021-05-13, Elliott Sales de Andrade
7e8c50c967bc
Parents 17208bd7a906
Children ac68d1f5962d
Add some missed docs for PidginCredential*

* Add `Since` tags for `PidginCredential`.
* Add docs for `PidginCredential*` top-level API.

Testing Done:
Compile

Reviewed at https://reviews.imfreedom.org/r/651/
2 files changed, 40 insertions(+), 0 deletions(-)
  • +23 -0
    pidgin/pidgincredentialproviderrow.h
  • +17 -0
    pidgin/pidgincredentialspage.h
    • --- a/pidgin/pidgincredentialproviderrow.h Thu May 13 22:27:15 2021 -0500
    +++ b/pidgin/pidgincredentialproviderrow.h Thu May 13 22:28:00 2021 -0500
    @@ -45,18 +45,35 @@
    G_BEGIN_DECLS
    +/**
    + * PIDGIN_TYPE_CREDENTIAL_PROVIDER_ROW:
    + *
    + * The standard _get_type macro for #PidginCredentialProviderRow.
    + *
    + * Since: 3.0.0
    + */
    #define PIDGIN_TYPE_CREDENTIAL_PROVIDER_ROW (pidgin_credential_provider_row_get_type())
    G_DECLARE_FINAL_TYPE(PidginCredentialProviderRow,
    pidgin_credential_provider_row,
    PIDGIN, CREDENTIAL_PROVIDER_ROW, HdyActionRow)
    /**
    + * PidginCredentialProviderRow:
    + *
    + * A widget that displays a credential provider.
    + *
    + * Since: 3.0.0
    + */
    +
    +/**
    * pidgin_credential_provider_row_new:
    * @provider: The credential provider to bind.
    *
    * Creates a new #PidginCredentialProviderRow instance.
    *
    * Returns: (transfer full): The new #PidginCredentialProviderRow instance.
    + *
    + * Since: 3.0.0
    */
    GtkWidget *pidgin_credential_provider_row_new(PurpleCredentialProvider *provider);
    @@ -67,6 +84,8 @@
    * Gets the #PurpleCredentialProvider displayed by this widget.
    *
    * Returns: (transfer none): The displayed #PurpleCredentialProvider.
    + *
    + * Since: 3.0.0
    */
    PurpleCredentialProvider *pidgin_credential_provider_row_get_provider(PidginCredentialProviderRow *row);
    @@ -77,6 +96,8 @@
    * Gets whether the row is displayed as active.
    *
    * Returns: Whether the row is active.
    + *
    + * Since: 3.0.0
    */
    gboolean pidgin_credential_provider_row_get_active(PidginCredentialProviderRow *row);
    @@ -86,6 +107,8 @@
    * @active: Whether to display as active.
    *
    * Sets whether the row is displayed as active.
    + *
    + * Since: 3.0.0
    */
    void pidgin_credential_provider_row_set_active(PidginCredentialProviderRow *row, gboolean active);
    --- a/pidgin/pidgincredentialspage.h Thu May 13 22:27:15 2021 -0500
    +++ b/pidgin/pidgincredentialspage.h Thu May 13 22:28:00 2021 -0500
    @@ -44,16 +44,33 @@
    G_BEGIN_DECLS
    +/**
    + * PIDGIN_TYPE_CREDENTIALS_PAGE:
    + *
    + * The standard _get_type macro for #PidginCredentialsPage.
    + *
    + * Since: 3.0.0
    + */
    #define PIDGIN_TYPE_CREDENTIALS_PAGE (pidgin_credentials_page_get_type())
    G_DECLARE_FINAL_TYPE(PidginCredentialsPage, pidgin_credentials_page,
    PIDGIN, CREDENTIALS_PAGE, HdyPreferencesPage)
    /**
    + * PidginCredentialsPage:
    + *
    + * A widget that displays a page of credential settings.
    + *
    + * Since: 3.0.0
    + */
    +
    +/**
    * pidgin_credentials_page_new:
    *
    * Creates a new #PidginCredentialsPage instance.
    *
    * Returns: (transfer full): The new #PidginCredentialsPage instance.
    + *
    + * Since: 3.0.0
    */
    GtkWidget *pidgin_credentials_page_new(void);