TextModel - Clear the buffers if the number of items is zero.

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / logical-model.h

diff --git a/dali-toolkit/internal/text/logical-model.h b/dali-toolkit/internal/text/logical-model.h
index b80e9b2..5d14098 100644 (file)
--- a/dali-toolkit/internal/text/logical-model.h
+++ b/dali-toolkit/internal/text/logical-model.h
@@ -62,6 +62,8 @@ public:
   /**
    * @brief Replaces any text previously set.
    *
+   * @note If the number of characters is zero the text buffer is cleared.
+   *
    * @param[in] text An array of UTF-32 characters.
    * @param[in] numberOfCharacters The length of the array.
    */
@@ -105,6 +107,8 @@ public:
    *
    * A run is a group of consecutive characters. A script run contains the script for a run.
    *
+   * @note If the number of runs is zero the script buffer is cleared.
+   *
    * @param[in] scripts Pointer to a buffer with all the script runs.
    * @param[in] numberOfRuns The number of script runs.
    */
@@ -154,6 +158,8 @@ public:
    *
    * A run is a group of consecutive characters. A font run contains the font id for a run.
    *
+   * @note If the number of runs is zero the font buffer is cleared.
+   *
    * @param[in] fonts Pointer to a buffer with all the font runs.
    * @param[in] numberOfRuns The number of font runs.
    */
@@ -205,6 +211,8 @@ public:
    *
    * Replaces any line break info previously set.
    *
+   * @note If the @length is zero the break info buffer is cleared.
+   *
    * @param[in] lineBreakInfo Pointer to a buffer with the line break info.
    * @param[in] length The size of the buffer.
    */
@@ -249,6 +257,8 @@ public:
    *
    * Replaces any word break info previously set.
    *
+   * @note If the @length is zero the break info buffer is cleared.
+   *
    * @param[in] wordBreakInfo Pointer to a buffer with the word break info.
    * @param[in] length The size of the buffer.
    */
@@ -300,6 +310,8 @@ public:
    * In terms of the bidirectional algorithm, a 'paragraph' is understood as a run of characters between Paragraph Separators or appropriate Newline Functions.
    * A 'paragraph' may also be determined by higher-level protocols like a mark-up tag.
    *
+   * @note If the number of runs is zero the bidirectional info buffer is cleared.
+   *
    * @param[in] bidirectionalInfo Pointer to a buffer with all the bidirectional info runs.
    * @param[in] numberOfRuns The number of bidirectional info runs.
    */
@@ -355,6 +367,8 @@ public:
    *
    * Replaces any map tables previously set.
    *
+   * @note If the number of runs is zero the bidirectional info buffer is cleared.
+   *
    * @param[in] bidirectionalInfo Pointer to a buffer with all the bidirectional info runs.
    * @param[in] numberOfRuns The number of bidirectional info runs.
    */