BDurationFormat::Format docs, update method params
Also a tiny style fix in the header, put const qualifier on same line
This commit is contained in:
@@ -111,18 +111,17 @@
|
|||||||
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\fn status_t BDurationFormat::Format(bigtime_t startValue,
|
\fn status_t BDurationFormat::Format(BString& buffer, bigtime_t startValue,
|
||||||
bigtime_t stopValue, BString* buffer, time_unit_style style) const
|
bigtime_t stopValue) const
|
||||||
\brief Formats a duration defined by its start and end values.
|
\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 start and end values are in milliseconds. The result is appended to
|
||||||
the buffer. The full time style uses full words (hours, minutes, seconds),
|
the buffer. The full time style uses full words (hours, minutes, seconds),
|
||||||
while the short one uses units (h, m, s).
|
while the short one uses units (h, m, s).
|
||||||
|
|
||||||
|
\param buffer The buffer to fill out.
|
||||||
\param startValue The start value in milliseconds.
|
\param startValue The start value in milliseconds.
|
||||||
\param stopValue The stop 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.
|
\returns A status code.
|
||||||
\retval B_OK Everything went fine.
|
\retval B_OK Everything went fine.
|
||||||
|
|||||||
@@ -40,8 +40,7 @@ public:
|
|||||||
|
|
||||||
status_t Format(BString& buffer,
|
status_t Format(BString& buffer,
|
||||||
const bigtime_t startValue,
|
const bigtime_t startValue,
|
||||||
const bigtime_t stopValue
|
const bigtime_t stopValue) const;
|
||||||
) const;
|
|
||||||
|
|
||||||
private:
|
private:
|
||||||
BString fSeparator;
|
BString fSeparator;
|
||||||
|
|||||||
Reference in New Issue
Block a user