pidgin/pidgin

Some random documentation fixes

2020-10-30, Gary Kramlich
ca0198d7ccdd
Parents ff16d3fc907e
Children 98384d15c7a0
Some random documentation fixes

Testing Done:
Built the docs

Reviewed at https://reviews.imfreedom.org/r/186/
3 files changed, 14 insertions(+), 8 deletions(-)
  • +4 -0
    doc/reference/libpurple/libpurple-docs.xml
  • +9 -7
    libpurple/purplecredentialprovider.h
  • +1 -1
    libpurple/purplekeyvaluepair.h
    • --- a/doc/reference/libpurple/libpurple-docs.xml Fri Oct 30 16:34:27 2020 -0500
    +++ b/doc/reference/libpurple/libpurple-docs.xml Fri Oct 30 16:34:33 2020 -0500
    @@ -182,6 +182,10 @@
    <title>Index of new symbols in 3.0.0</title>
    <xi:include href="xml/api-index-3.0.0.xml"><xi:fallback /></xi:include>
    </index>
    + <index id="api-2.14.0">
    + <title>Index of new symbols in 2.14.0</title>
    + <xi:include href="xml/api-index-2.14.0.xml"><xi:fallback /></xi:include>
    + </index>
    <index id="api-2.13.0">
    <title>Index of new symbols in 2.13.0</title>
    <xi:include href="xml/api-index-2.13.0.xml"><xi:fallback /></xi:include>
    --- a/libpurple/purplecredentialprovider.h Fri Oct 30 16:34:27 2020 -0500
    +++ b/libpurple/purplecredentialprovider.h Fri Oct 30 16:34:33 2020 -0500
    @@ -159,10 +159,10 @@
    * @provider: The #PurpleCredentialProvider instance.
    * @account: The #PurpleAccount whose password we're looking up.
    * @result: The #GAsyncResult from the previous
    - * purple_credential_provider_read_password() call.
    + * purple_credential_provider_read_password_async() call.
    * @error: (out) (optional): Return address for a #GError.
    *
    - * Finishes a previous call to purple_credential_provider_read_password().
    + * Finishes a previous call to purple_credential_provider_read_password_async().
    *
    * Returns: (transfer full): The password or %NULL if successful, otherwise
    * %NULL with @error set on failure.
    @@ -192,10 +192,11 @@
    * @provider: The #PurpleCredentialProvider instance.
    * @account: The #PurpleAccount whose password we're writing.
    * @result: The #GAsyncResult from the previous
    - * purple_credential_provider_write_password() call.
    + * purple_credential_provider_write_password_async() call.
    * @error: (out) (optional): Return address for a #GError.
    *
    - * Finishes a previous call to purple_credential_provider_write_password().
    + * Finishes a previous call to
    + * purple_credential_provider_write_password_async().
    *
    * Returns: %TRUE if the password was written successfully, otherwise %FALSE
    * with @error set.
    @@ -224,10 +225,11 @@
    * @provider: The #PurpleCredentialProvider instance.
    * @account: The #PurpleAccount whose password we're clearing.
    * @result: The #GAsyncResult from the previous
    - * purple_credential_provider_clear_password() call.
    + * purple_credential_provider_clear_password_async() call.
    * @error: (out) (optional): Return address for a #GError.
    *
    - * Finishes a previous call to purple_credential_provider_clear_password().
    + * Finishes a previous call to
    + * purple_credential_provider_clear_password_async().
    *
    * Returns: %TRUE if the password was cleared successfully, otherwise %FALSE
    * with @error set.
    @@ -249,7 +251,7 @@
    /**
    * purple_credential_provider_read_settings:
    - * @provider: The #PurpleCredentialProviderInstance.
    + * @provider: The #PurpleCredentialProvider instance.
    *
    * Reads settings from @provider.
    *
    --- a/libpurple/purplekeyvaluepair.h Fri Oct 30 16:34:27 2020 -0500
    +++ b/libpurple/purplekeyvaluepair.h Fri Oct 30 16:34:33 2020 -0500
    @@ -114,7 +114,7 @@
    *
    * Creates a copy of @kvp.
    *
    - * If @kvp has a %value_destroy_func, %NULL will be returned as this function
    + * If @kvp has a value_destroy_func, %NULL will be returned as this function
    * has no way to know how to allocate a new copy of the value.
    *
    * Returns: (transfer full): A new copy of @kvp.