From 6f6c9e00696472addfbb94266353be82a990bda2 Mon Sep 17 00:00:00 2001 From: John Scipione Date: Fri, 10 Nov 2017 14:59:01 -0800 Subject: [PATCH] BDurationFormat::Format docs, update method params Also a tiny style fix in the header, put const qualifier on same line --- docs/user/locale/DurationFormat.dox | 7 +++---- headers/os/locale/DurationFormat.h | 3 +-- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/user/locale/DurationFormat.dox b/docs/user/locale/DurationFormat.dox index ef0cfda204..0f54e1fa60 100644 --- a/docs/user/locale/DurationFormat.dox +++ b/docs/user/locale/DurationFormat.dox @@ -111,18 +111,17 @@ /*! - \fn status_t BDurationFormat::Format(bigtime_t startValue, - bigtime_t stopValue, BString* buffer, time_unit_style style) const + \fn status_t BDurationFormat::Format(BString& buffer, bigtime_t startValue, + bigtime_t stopValue) const \brief Formats a duration defined by its start and end values. The start and end values are in milliseconds. The result is appended to the buffer. The full time style uses full words (hours, minutes, seconds), while the short one uses units (h, m, s). + \param buffer The buffer to fill out. \param startValue The start value in milliseconds. \param stopValue The stop value in milliseconds. - \param buffer The buffer to fill out. - \param style The time unit style to use. \returns A status code. \retval B_OK Everything went fine. diff --git a/headers/os/locale/DurationFormat.h b/headers/os/locale/DurationFormat.h index fa0e92cc64..3db8203f75 100644 --- a/headers/os/locale/DurationFormat.h +++ b/headers/os/locale/DurationFormat.h @@ -40,8 +40,7 @@ public: status_t Format(BString& buffer, const bigtime_t startValue, - const bigtime_t stopValue - ) const; + const bigtime_t stopValue) const; private: BString fSeparator;