Update sample codes in doxygen comments
authorbs0111.cho <bs0111.cho@samsung.com>
Fri, 31 May 2013 02:29:20 +0000 (11:29 +0900)
committerbs0111.cho <bs0111.cho@samsung.com>
Wed, 5 Jun 2013 05:20:06 +0000 (14:20 +0900)
Change-Id: I298481774bd323095a708edbf2e3e55f990a1bf6
Signed-off-by: bs0111.cho <bs0111.cho@samsung.com>
inc/FUiImeIInputMethodListener.h [changed mode: 0644->0755]
inc/FUiImeIInputMethodProvider.h [changed mode: 0644->0755]
inc/FUiImeIInputMethodProviderF.h
inc/FUiImeInputMethod.h [changed mode: 0644->0755]

old mode 100644 (file)
new mode 100755 (executable)
index 0299c36..31fc21a
@@ -45,16 +45,16 @@ namespace Tizen { namespace Ui { namespace Ime {
  *
  * The following example demonstrates how to use the %IInputMethodListener interface.
  * @code
- * #include <FUi.h>
+ * #include <FUiIme.h>
+ *
+ * using namespace Tizen::Ui::Ime;
  *
  * class MyListener
  *     : public IInputMethodListener
  * {
- *     //...
- *     virtual void OnCursorPositionChanged(int position); 
- *     virtual void OnOpaqueCommandReceived(const Tizen::Base::String& command); 
- *     virtual void OnSurroundingTextReceived(const Tizen::Base::String& text, int cursorPosition);
- *     //...
+ *     virtual void OnCursorPositionChanged(int position) {}
+ *     virtual void OnOpaqueCommandReceived(const Tizen::Base::String& command) {}
+ *     virtual void OnSurroundingTextReceived(const Tizen::Base::String& text, int cursorPosition) {}
  * };
  * @endcode
  *
old mode 100644 (file)
new mode 100755 (executable)
index 558828c..6dd450a
@@ -45,16 +45,18 @@ namespace Tizen { namespace Ui { namespace Ime {
  *
  * The following example demonstrates how to use the %IInputMethodProvider interface.
  * @code
- * #include <FUi.h>
+ * #include <FGraphics.h>
+ * #include <FUiIme.h>
+ *
+ * using namespace Tizen::Graphics;
+ * using namespace Tizen::Ui::Ime;
  *
  * class MyProvider
  *     : public IInputMethodProvider
  * {
- *     //...
- *     virtual Tizen::Graphics::Rectangle GetInputPanelBounds(void); 
- *     virtual void HideInputPanel(void); 
- *     virtual void ShowInputPanel(void); 
- *     //...
+ *     virtual Rectangle GetInputPanelBounds(void) { return Rectangle(); }
+ *     virtual void HideInputPanel(void) {}
+ *     virtual void ShowInputPanel(void) {}
  * };
  * @endcode
  *
index 0a0c9e6..668d46b 100755 (executable)
@@ -45,16 +45,18 @@ namespace Tizen { namespace Ui { namespace Ime {
  *
  * The following example demonstrates how to use the %IInputMethodProviderF interface.
  * @code
- * #include <FUi.h>
+ * #include <FGraphics.h>
+ * #include <FUiIme.h>
+ *
+ * using namespace Tizen::Graphics;
+ * using namespace Tizen::Ui::Ime;
  *
  * class MyProvider
  *     : public IInputMethodProviderF
  * {
- *     //...
- *     virtual Tizen::Graphics::FloatRectangle GetInputPanelBounds(void); 
- *     virtual void HideInputPanel(void); 
- *     virtual void ShowInputPanel(void); 
- *     //...
+ *     virtual FloatRectangle GetInputPanelBounds(void) { return FloatRectangle(); }
+ *     virtual void HideInputPanel(void) {}
+ *     virtual void ShowInputPanel(void) {}
  * };
  * @endcode
  *
old mode 100644 (file)
new mode 100755 (executable)
index e7374c0..9708905
@@ -55,43 +55,59 @@ class _InputMethodImpl;
  * The following example demonstrates how to use the %InputMethod class.
  * @code
  * #include <new>
- * #include <FUi.h>
  *
+ * #include <FGraphics.h>
+ * #include <FUiIme.h>
+ *
+ * using namespace Tizen::Graphics;
  * using namespace Tizen::Ui::Ime;
  *
  * class MyProvider
- *     : public IInputMethodProvider
+ *     : public IInputMethodProviderF
  * {
- *             //...
+ *     virtual FloatRectangle GetInputPanelBounds(void) { return FloatRectangle(); }
+ *     virtual void HideInputPanel(void) {}
+ *     virtual void ShowInputPanel(void) {}
  * };
  *
  * class MyListener
  *     : public IInputMethodListener
  * {
- *             //...
+ *     virtual void OnCursorPositionChanged(int position) {}
+ *     virtual void OnOpaqueCommandReceived(const Tizen::Base::String& command) {}
+ *     virtual void OnSurroundingTextReceived(const Tizen::Base::String& text, int cursorPosition) {}
  * };
  *
  * class MyImeApp
  * {
  * public:
- *             //...
- *     void Construct();
- * };
+ *     MyImeApp(void)
+ *     {
+ *             // Gets an instance of InputMethod
+ *             InputMethod* pInputMethod = InputMethod::GetInstance();
  *
- * void
- * MyImeApp::Construct()
- * {
- *     // Gets an instance of InputMethod
- *     InputMethod* pInputMethod = InputMethod::GetInstance();
+ *             // Creates an instance of MyProvider and sets it as a provider
+ *             __pMyProvider = new(std::nothrow) MyProvider();
+ *             pInputMethod->SetInputMethodProviderF(__pMyProvider);
  *
- *     // Creates an instance of MyProvider and sets it as a provider
- *     MyProvider* pMyProvider = new(std::nothrow) MyProvider();
- *     pInputMethod->SetInputMethodProvider(pMyProvider);
+ *             // Creates an instance of MyListener and adds it to the input method
+ *             __pMyListener = new(std::nothrow) MyListener();
+ *             pInputMethod->SetInputMethodListener(__pMyListener);
+ *     }
  *
- *     // Creates an instance of MyListener and adds it to the input method
- *     MyListener* pMyListener = new(std::nothrow) MyListener();
- *     pInputMethod->SetInputMethodListener(pMyListener);
- * }
+ *     virtual ~MyImeApp(void)
+ *     {
+ *             delete __pMyProvider;
+ *             __pMyProvider = null;
+ *
+ *             delete __pMyListener;
+ *             __pMyListener = null;
+ *     }
+ *
+ * private:
+ *     MyProvider* __pMyProvider;
+ *     MyListener* __pMyListener;
+ * };
  * @endcode
  *
  */