Update some Doxygen comment.

This commit is contained in:
Mark de Wever 2014-05-09 19:46:03 +02:00
parent 9fb69370a8
commit 3a36b5288d

View File

@ -85,10 +85,10 @@ public:
bool is_truncated() const; bool is_truncated() const;
/** /**
* Inserts utf 8 text. * Inserts UTF-8 text.
* *
* @param offset The position to insert the text. * @param offset The position to insert the text.
* @param text The utf-8 text to insert. * @param text The UTF-8 text to insert.
* *
* @returns The number of characters inserted. * @returns The number of characters inserted.
*/ */
@ -157,7 +157,7 @@ public:
/** /**
* Gets the length of the text in characters. * Gets the length of the text in characters.
* *
* The text set is utf-8 so the length of the string might not be the length * The text set is UTF-8 so the length of the string might not be the length
* of the text. * of the text.
*/ */
size_t get_length() const { return length_; } size_t get_length() const { return length_; }
@ -208,7 +208,7 @@ private:
/** The surface to render upon used as a cache. */ /** The surface to render upon used as a cache. */
mutable surface surface_; mutable surface surface_;
/** The text to draw (stored as utf-8). */ /** The text to draw (stored as UTF-8). */
std::string text_; std::string text_;
/** Is the text markedup if so the markedup render routines need to be used. */ /** Is the text markedup if so the markedup render routines need to be used. */