From 7ec9bf2f5aec82448dd9f0462e2a7897190dd9eb Mon Sep 17 00:00:00 2001 From: John Scipione Date: Thu, 4 Dec 2014 19:33:35 -0500 Subject: [PATCH] A few more small fixes, trying to go quick --- docs/user/locale/DateFormat.dox | 8 ++++---- docs/user/locale/DateTimeFormat.dox | 4 ++-- docs/user/locale/TimeFormat.dox | 24 ++++++++++++------------ 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/user/locale/DateFormat.dox b/docs/user/locale/DateFormat.dox index dd14bffbc8..133b0c5e40 100644 --- a/docs/user/locale/DateFormat.dox +++ b/docs/user/locale/DateFormat.dox @@ -80,7 +80,7 @@ \returns The number of bytes written during the date formatting. \retval B_ERROR Unable to lock the BLocale. - \retval B_NO_MEMORY Ran out of memory while creating the DateFormat object. + \retval B_NO_MEMORY Ran out of memory while creating the object. \retval B_BAD_VALUE CheckedArrayByteSink overflowed. \since Haiku R1 @@ -102,7 +102,7 @@ \returns A status code. \retval B_OK Everything went fine. \retval B_ERROR Unable to lock the BLocale. - \retval B_NO_MEMORY Ran out of memory while creating the DateFormat object. + \retval B_NO_MEMORY Ran out of memory while creating the object. \since Haiku R1 */ @@ -125,7 +125,7 @@ \returns A status code. \retval B_OK Everything went fine. \retval B_ERROR Unable to lock the BLocale. - \retval B_NO_MEMORY Ran out of memory while creating the DateFormat object. + \retval B_NO_MEMORY Ran out of memory while creating the object. \retval B_BAD_VALUE An error occurred while performing the date formatting. \since Haiku R1 @@ -151,7 +151,7 @@ \returns A status code. \retval B_OK Everything went fine. \retval B_ERROR Unable to lock the BLocale. - \retval B_NO_MEMORY Ran out of memory while creating the DateFormat object. + \retval B_NO_MEMORY Ran out of memory while creating the object. \retval B_BAD_VALUE An error occurred while getting the date fields. \sa BDateFormat::GetTimeFields(BDateElement*& fields, int& fieldCount, diff --git a/docs/user/locale/DateTimeFormat.dox b/docs/user/locale/DateTimeFormat.dox index adbf08ab8c..78f0c8b8c2 100644 --- a/docs/user/locale/DateTimeFormat.dox +++ b/docs/user/locale/DateTimeFormat.dox @@ -81,7 +81,7 @@ \returns The number of bytes written during the datetime formatting. \retval B_ERROR Unable to lock the BLocale. - \retval B_NO_MEMORY Ran out of memory while creating the DateFormat object. + \retval B_NO_MEMORY Ran out of memory while creating the object. \retval B_BAD_VALUE CheckedArrayByteSink overflowed. \since Haiku R1 @@ -104,7 +104,7 @@ \returns A status code. \retval B_OK Everything went fine. \retval B_ERROR Unable to lock the BLocale. - \retval B_NO_MEMORY Ran out of memory while creating the DateFormat object. + \retval B_NO_MEMORY Ran out of memory while creating the object. \since Haiku R1 */ diff --git a/docs/user/locale/TimeFormat.dox b/docs/user/locale/TimeFormat.dox index 65fbf3bdc9..1cdd9a0296 100644 --- a/docs/user/locale/TimeFormat.dox +++ b/docs/user/locale/TimeFormat.dox @@ -7,8 +7,8 @@ * John Scipione, jscipione@gmail.com * * Corresponds to: - * headers/os/locale/DateFormat.h hrev48439 - * src/kits/locale/DateFormat.cpp hrev48439 + * headers/os/locale/TimeFormat.h hrev48439 + * src/kits/locale/TimeFormat.cpp hrev48439 */ @@ -77,7 +77,7 @@ \returns The number of bytes written during the time formatting. \retval B_ERROR Unable to lock the BLocale. - \retval B_NO_MEMORY Ran out of memory while creating the DateFormat object. + \retval B_NO_MEMORY Ran out of memory while creating the object. \retval B_BAD_VALUE CheckedArrayByteSink overflowed. \since Haiku R1 @@ -90,14 +90,14 @@ \brief Fills in \a string with a formatted time for the given \a time, \a style, and \a timeZone for the locale. - \param string The string buffer to fill with the formatted date. + \param string The string buffer to fill with the formatted time. \param time The time (in seconds since epoch) to format \param style Specify the long format or the short format. \returns A status code. \retval B_OK Everything went fine. \retval B_ERROR Unable to lock the BLocale. - \retval B_NO_MEMORY Ran out of memory while creating the DateFormat object. + \retval B_NO_MEMORY Ran out of memory while creating the object. \sa BLocale::FormatDate(BString *string, time_t time, BTimeFormatStyle style, const BTimeZone* timeZone) const @@ -124,7 +124,7 @@ \returns A status code. \retval B_OK Everything went fine. \retval B_ERROR Unable to lock the BLocale. - \retval B_NO_MEMORY Ran out of memory while creating the DateFormat object. + \retval B_NO_MEMORY Ran out of memory while creating the object. \retval B_BAD_VALUE An error occurred during time formatting. \since Haiku R1 @@ -138,8 +138,8 @@ \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. + \param string The string buffer to fill with the formatted time. + \param fieldPositions An array of time field positions to use. \param fieldCount The number of \a fields in \a fieldPositions. \param time The time (in seconds since epoch) to format \param style Specify the long format (with day name, full @@ -148,8 +148,8 @@ \returns A status code. \retval B_OK Everything went fine. \retval B_ERROR Unable to lock the BLocale. - \retval B_NO_MEMORY Ran out of memory while creating the DateFormat object. - \retval B_BAD_VALUE An error occurred while performing the date formatting. + \retval B_NO_MEMORY Ran out of memory while creating the object. + \retval B_BAD_VALUE An error occurred while performing the time formatting. \since Haiku R1 */ @@ -163,7 +163,7 @@ This method is used most often in combination with FormatTime(). FormatTime() gives you the offset of each field in a formatted string, and GetTimeFields() gives you the type of the field at a given offset. - With this information you can handle the formatted date string as + With this information you can handle the formatted time string as a list of fields that you can split and alter at will. \param fields Pointer to the fields object. @@ -173,7 +173,7 @@ \returns A status code. \retval B_OK Everything went fine. \retval B_ERROR Unable to lock the BLocale. - \retval B_NO_MEMORY Ran out of memory while creating the DateFormat object. + \retval B_NO_MEMORY Ran out of memory while creating the object. \retval B_BAD_VALUE An error occurred while getting the time fields. \since Haiku R1