pidgin/android/libpurple

Add examples for the purple_date_format functions

2013-02-18, Mark Doliner
e176320b17f4
Parents 878c94d4ffb3
Children 20349cbb57a0
Add examples for the purple_date_format functions
1 files changed, 8 insertions(+), 4 deletions(-)
  • +8 -4
    libpurple/util.h
    • --- a/libpurple/util.h Mon Feb 18 14:42:16 2013 -0800
    +++ b/libpurple/util.h Mon Feb 18 15:41:48 2013 -0800
    @@ -383,7 +383,8 @@
    *
    * @param tm The time to format, or @c NULL to use the current local time
    *
    - * @return The date, formatted as per the user's settings.
    + * @return The date, formatted as per the user's settings. In the USA this
    + * is something like "02/18/13"
    */
    const char *purple_date_format_short(const struct tm *tm);
    @@ -395,7 +396,8 @@
    *
    * @param tm The time to format, or @c NULL to use the current local time
    *
    - * @return The timestamp, formatted as per the user's settings.
    + * @return The timestamp, formatted as per the user's settings. In the USA
    + * this is something like "02/18/13 15:26:44"
    */
    const char *purple_date_format_long(const struct tm *tm);
    @@ -407,7 +409,8 @@
    *
    * @param tm The time to format, or @c NULL to use the current local time
    *
    - * @return The date and time, formatted as per the user's settings.
    + * @return The date and time, formatted as per the user's settings. In the
    + * USA this is something like "Mon Feb 18 15:26:44 2013"
    */
    const char *purple_date_format_full(const struct tm *tm);
    @@ -419,7 +422,8 @@
    *
    * @param tm The time to format, or @c NULL to use the current local time
    *
    - * @return The time, formatted as per the user's settings.
    + * @return The time, formatted as per the user's settings. In the USA this
    + * is something like "15:26:44"
    */
    const char *purple_time_format(const struct tm *tm);