Add comment to SetMarkupProcessingEnabled() dali-2014-wk22-release
authorSunhyun Kim <scholb.kim@samsung.com>
Mon, 26 May 2014 07:22:37 +0000 (16:22 +0900)
committerAdeel Kazmi <adeel.kazmi@samsung.com>
Thu, 29 May 2014 14:10:35 +0000 (15:10 +0100)
Application developer can confuse using SetMarkupProcessingEnabled().
i add one example.

 1) TextView text = Toolkit::TextView::New( MarkupText[] );
 2) text.SetMarkupProcessingEnabled(true);

developer can think MarkupText already enable markupProcessing.
but SetMarkupProcessingEnabled is adapted after SetText().
so i added simply comment to SetMarkupProcessingEnabled().

capi/dali-toolkit/public-api/controls/text-view/text-view.h

index 796c18f..6bf42fe 100644 (file)
@@ -557,6 +557,9 @@ public:
   /**
    * @brief Sets whether markup processing should be carried out.
    *
+   * To use markup, applications need to SetMarkupProcessingEnabled first, then SetText().
+   *
+   * @see SetText()
    * @param[in] enable whether markup processing is carried out or not.
    */
   void SetMarkupProcessingEnabled( bool enable );