Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

BDurationFormat::Format docs, update method params

Browse Source 
Also a tiny style fix in the header, put const qualifier
on same line
This commit is contained in:
John Scipione 2017-11-10 14:59:01 -08:00
parent 021c2fec4f
commit 6f6c9e0069
2 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/user/locale/DurationFormat.dox
View File

@ -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.

3
headers/os/locale/DurationFormat.h
View File

@ -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;