Mercurial > pidgin.yaz
comparison libpurple/account.h @ 32687:02a2e8183b1d
Clean the API documentation in preparation for 3.0.0 by removing all the old @since tags.
author | andrew.victor@mxit.com |
---|---|
date | Sun, 25 Sep 2011 18:56:58 +0000 |
parents | cd1d9e04c587 |
children | 839116243947 |
comparison
equal
deleted
inserted
replaced
32685:9d5b87e1a4d0 | 32687:02a2e8183b1d |
---|---|
431 /** | 431 /** |
432 * Sets the account's privacy type. | 432 * Sets the account's privacy type. |
433 * | 433 * |
434 * @param account The account. | 434 * @param account The account. |
435 * @param privacy_type The privacy type. | 435 * @param privacy_type The privacy type. |
436 * | |
437 * @since 2.7.0 | |
438 */ | 436 */ |
439 void purple_account_set_privacy_type(PurpleAccount *account, PurplePrivacyType privacy_type); | 437 void purple_account_set_privacy_type(PurpleAccount *account, PurplePrivacyType privacy_type); |
440 | 438 |
441 /** | 439 /** |
442 * Sets the account's status types. | 440 * Sets the account's status types. |
489 * a protocol-specific "default", like the username) | 487 * a protocol-specific "default", like the username) |
490 * @param success_cb A callback which will be called if the alias | 488 * @param success_cb A callback which will be called if the alias |
491 * is successfully set on the server (or NULL). | 489 * is successfully set on the server (or NULL). |
492 * @param failure_cb A callback which will be called if the alias | 490 * @param failure_cb A callback which will be called if the alias |
493 * is not successfully set on the server (or NULL). | 491 * is not successfully set on the server (or NULL). |
494 * | |
495 * @since 2.7.0 | |
496 */ | 492 */ |
497 void purple_account_set_public_alias(PurpleAccount *account, | 493 void purple_account_set_public_alias(PurpleAccount *account, |
498 const char *alias, PurpleSetPublicAliasSuccessCallback success_cb, | 494 const char *alias, PurpleSetPublicAliasSuccessCallback success_cb, |
499 PurpleSetPublicAliasFailureCallback failure_cb); | 495 PurpleSetPublicAliasFailureCallback failure_cb); |
500 | 496 |
504 * | 500 * |
505 * @param account The account | 501 * @param account The account |
506 * @param success_cb A callback which will be called with the alias | 502 * @param success_cb A callback which will be called with the alias |
507 * @param failure_cb A callback which will be called if the prpl is | 503 * @param failure_cb A callback which will be called if the prpl is |
508 * unable to retrieve the server-side alias. | 504 * unable to retrieve the server-side alias. |
509 * @since 2.7.0 | |
510 */ | 505 */ |
511 void purple_account_get_public_alias(PurpleAccount *account, | 506 void purple_account_get_public_alias(PurpleAccount *account, |
512 PurpleGetPublicAliasSuccessCallback success_cb, | 507 PurpleGetPublicAliasSuccessCallback success_cb, |
513 PurpleGetPublicAliasFailureCallback failure_cb); | 508 PurpleGetPublicAliasFailureCallback failure_cb); |
514 | 509 |
540 /** | 535 /** |
541 * Removes an account-specific setting by name. | 536 * Removes an account-specific setting by name. |
542 * | 537 * |
543 * @param account The account. | 538 * @param account The account. |
544 * @param setting The setting to remove. | 539 * @param setting The setting to remove. |
545 * | |
546 * @since 2.6.0 | |
547 */ | 540 */ |
548 void purple_account_remove_setting(PurpleAccount *account, const char *setting); | 541 void purple_account_remove_setting(PurpleAccount *account, const char *setting); |
549 | 542 |
550 /** | 543 /** |
551 * Sets a protocol-specific integer setting for an account. | 544 * Sets a protocol-specific integer setting for an account. |
715 * the account's username. | 708 * the account's username. |
716 * | 709 * |
717 * @param account The account. | 710 * @param account The account. |
718 * | 711 * |
719 * @return The name to display. | 712 * @return The name to display. |
720 * | |
721 * @since 2.7.0 | |
722 */ | 713 */ |
723 const gchar *purple_account_get_name_for_display(const PurpleAccount *account); | 714 const gchar *purple_account_get_name_for_display(const PurpleAccount *account); |
724 | 715 |
725 /** | 716 /** |
726 * Returns whether or not this account should save its password. | 717 * Returns whether or not this account should save its password. |
765 * Returns the account's privacy type. | 756 * Returns the account's privacy type. |
766 * | 757 * |
767 * @param account The account. | 758 * @param account The account. |
768 * | 759 * |
769 * @return The privacy type. | 760 * @return The privacy type. |
770 * | |
771 * @since 2.7.0 | |
772 */ | 761 */ |
773 PurplePrivacyType purple_account_get_privacy_type(const PurpleAccount *account); | 762 PurplePrivacyType purple_account_get_privacy_type(const PurpleAccount *account); |
774 | 763 |
775 /** | 764 /** |
776 * Returns the active status for this account. This looks through | 765 * Returns the active status for this account. This looks through |