[haiku-commits] haiku: hrev48442 - docs/user/locale

  • From: jscipione@xxxxxxxxx
  • To: haiku-commits@xxxxxxxxxxxxx
  • Date: Fri, 5 Dec 2014 01:23:59 +0100 (CET)

hrev48442 adds 1 changeset to branch 'master'
old head: 4a31c3262018a36b9c920caca1be0034d6836923
new head: 9bd3dedfce504306851b30c48e3288ec4f8d2b2e
overview: http://cgit.haiku-os.org/haiku/log/?qt=range&q=9bd3ded+%5E4a31c32

----------------------------------------------------------------------------

9bd3ded: Fix a bit of copy pasta in the locale docs

                                     [ John Scipione <jscipione@xxxxxxxxx> ]

----------------------------------------------------------------------------

Revision:    hrev48442
Commit:      9bd3dedfce504306851b30c48e3288ec4f8d2b2e
URL:         http://cgit.haiku-os.org/haiku/commit/?id=9bd3ded
Author:      John Scipione <jscipione@xxxxxxxxx>
Date:        Fri Dec  5 00:23:47 2014 UTC

----------------------------------------------------------------------------

3 files changed, 13 insertions(+), 12 deletions(-)
docs/user/locale/DateFormat.dox     |  4 ++--
docs/user/locale/DateTimeFormat.dox | 10 +++++-----
docs/user/locale/TimeFormat.dox     | 11 ++++++-----

----------------------------------------------------------------------------

diff --git a/docs/user/locale/DateFormat.dox b/docs/user/locale/DateFormat.dox
index fe9a9f8..dd14bff 100644
--- a/docs/user/locale/DateFormat.dox
+++ b/docs/user/locale/DateFormat.dox
@@ -112,8 +112,8 @@
        \fn status_t BDateFormat::Format(BString& string,
                int*& fieldPositions, int& fieldCount, const time_t time,
                const BDateFormatStyle style) const
-       \brief Fills in \a string with a formatted date for the given
-              \a time and \a style for the locale.
+       \brief Fills in \a string with a custom formatted date according to the
+              given parameters for the locale.
 
        \param string The string buffer to fill with the formatted date.
        \param fieldPositions An array of date field positions to use.
diff --git a/docs/user/locale/DateTimeFormat.dox 
b/docs/user/locale/DateTimeFormat.dox
index d3a2cf3..adbf08a 100644
--- a/docs/user/locale/DateTimeFormat.dox
+++ b/docs/user/locale/DateTimeFormat.dox
@@ -7,16 +7,16 @@
  *             John Scipione, jscipione@xxxxxxxxx
  *
  * Corresponds to:
- *             headers/os/locale/DateFormat.h  hrev48439
- *             src/kits/locale/DateFormat.cpp  hrev48439
+ *             headers/os/locale/DateTimeFormat.h      hrev48439
+ *             src/kits/locale/DateTimeFormat.cpp      hrev48439
  */
 
 
 /*!
-       \file DateFormat.h
+       \file DateTimeFormat.h
        \ingroup locale
        \ingroup libbe
-       \brief Contains BDateTimeFormat class, a date formatter.
+       \brief Contains BDateTimeFormat class, a datetime formatter.
 */
 
 
@@ -24,7 +24,7 @@
        \class BDateTimeFormat
        \ingroup locale
        \ingroup libbe
-       \brief Formatter for dates.
+       \brief Formatter for datetimes.
 
        \since Haiku R1
 */
diff --git a/docs/user/locale/TimeFormat.dox b/docs/user/locale/TimeFormat.dox
index 7e914ca..65fbf3b 100644
--- a/docs/user/locale/TimeFormat.dox
+++ b/docs/user/locale/TimeFormat.dox
@@ -13,10 +13,10 @@
 
 
 /*!
-       \file DateFormat.h
+       \file TimeFormat.h
        \ingroup locale
        \ingroup libbe
-       \brief Contains BTimeFormat class, a date formatter.
+       \brief Contains BTimeFormat class, a time formatter.
 */
 
 
@@ -24,7 +24,7 @@
        \class BTimeFormat
        \ingroup locale
        \ingroup libbe
-       \brief Formatter for dates.
+       \brief Formatter for times.
 
        \since Haiku R1
 */
@@ -67,7 +67,7 @@
 /*!
        \fn ssize_t BTimeFormat::Format(char* string, size_t maxSize, time_t 
time,
                BTimeFormatStyle style) const
-       \brief Fills in \a string with a formatted date up to \a maxSize bytes 
for
+       \brief Fills in \a string with a formatted time up to \a maxSize bytes 
for
               the given \a time and \a style for the locale.
 
        \param string The string buffer to fill with the formatted time.
@@ -135,7 +135,8 @@
        \fn status_t BTimeFormat::Format(BString& string,
                int*& fieldPositions, int& fieldCount,
                time_t time, BTimeFormatStyle style) const
-       \brief Fills in \a string with a formatted time for the given 
parameters.
+       \brief Fills in \a string with a custom formatted time according to the
+              given parameters for the locale.
 
        \param string The string buffer to fill with the formatted date.
        \param fieldPositions An array of date field positions to use.


Other related posts:

  • » [haiku-commits] haiku: hrev48442 - docs/user/locale - jscipione