[3.0] Add missed doxygen documentation

- Parameters of some members are not documented.
- Enumeration of some classes are not documented.
- Return types of some members are not documented.

Change-Id: I082e4f3bfd451c8ef8e0034afdd5b83819855464
Signed-off-by: Seoyeon Kim <seoyeon2.kim@samsung.com>

diff --git a/adaptors/public-api/adaptor-framework/application.h b/adaptors/public-api/adaptor-framework/application.h
index e690d9b..1d052e8 100644 (file)
--- a/adaptors/public-api/adaptor-framework/application.h
+++ b/adaptors/public-api/adaptor-framework/application.h
@@ -128,6 +128,7 @@ public:
    * @SINCE_1_0.0
    * @PRIVLEVEL_PUBLIC
    * @PRIVILEGE_DISPLAY
+   * @return A handle to the Application
    */
   static Application New();
 
@@ -139,6 +140,7 @@ public:
    * @PRIVILEGE_DISPLAY
    * @param[in,out]  argc        A pointer to the number of arguments
    * @param[in,out]  argv        A pointer the the argument list
+   * @return A handle to the Application
    */
   static Application New( int* argc, char **argv[] );
 
@@ -151,6 +153,7 @@ public:
    * @param[in,out]  argc        A pointer to the number of arguments
    * @param[in,out]  argv        A pointer the the argument list
    * @param[in]      stylesheet  The path to user defined theme file
+   * @return A handle to the Application
    * @note If the stylesheet is not specified, then the library's default stylesheet will not be overridden.
    */
   static Application New( int* argc, char **argv[], const std::string& stylesheet );
@@ -165,6 +168,7 @@ public:
    * @param[in,out]  argv        A pointer the the argument list
    * @param[in]      stylesheet  The path to user defined theme file
    * @param[in]      windowMode  A member of WINDOW_MODE
+   * @return A handle to the Application
    * @note If the stylesheet is not specified, then the library's default stylesheet will not be overridden.
    */
   static Application New( int* argc, char **argv[], const std::string& stylesheet, WINDOW_MODE windowMode );
@@ -178,14 +182,17 @@ public:
   /**
    * @brief Copy Constructor
    * @SINCE_1_0.0
+   * @param[in] application Handle to an object
    */
   Application( const Application& application );
 
   /**
    * @brief Assignment operator
    * @SINCE_1_0.0
+   * @param[in] application Handle to an object
+   * @return A reference to this
    */
-  Application& operator=( const Application& applicaton );
+  Application& operator=( const Application& application );
 
   /**
    * @brief Destructor
@@ -214,6 +221,7 @@ public:
    * trigger context loss & regain.
    * The application should listen to Stage::ContextLostSignal and Stage::ContextRegainedSignal.
    * @SINCE_1_0.0
+   * @param[in] configuration The context loss configuration
    */
   void MainLoop(Configuration::ContextLoss configuration);
 
@@ -310,6 +318,7 @@ public:  // Signals
    * @brief The user should connect to this signal to determine when they should initialise
    * their application.
    * @SINCE_1_0.0
+   * @return The signal to connect to
    */
   AppSignalType& InitSignal();
 
@@ -317,6 +326,7 @@ public:  // Signals
    * @brief The user should connect to this signal to determine when they should terminate
    * their application
    * @SINCE_1_0.0
+   * @return The signal to connect to
    */
   AppSignalType& TerminateSignal();
 
@@ -324,6 +334,7 @@ public:  // Signals
    * @brief The user should connect to this signal if they need to perform any special
    * activities when the application is about to be paused.
    * @SINCE_1_0.0
+   * @return The signal to connect to
    */
   AppSignalType& PauseSignal();
 
@@ -331,18 +342,21 @@ public:  // Signals
    * @brief The user should connect to this signal if they need to perform any special
    * activities when the application has resumed.
    * @SINCE_1_0.0
+   * @return The signal to connect to
    */
   AppSignalType& ResumeSignal();
 
   /**
    * @brief This signal is sent when the system requires the user to reinitialise itself.
    * @SINCE_1_0.0
+   * @return The signal to connect to
    */
   AppSignalType& ResetSignal();
 
   /**
    * @brief This signal is emitted when the window the application is rendering on is resized.
    * @SINCE_1_0.0
+   * @return The signal to connect to
    */
   AppSignalType& ResizeSignal();
 
@@ -352,30 +366,35 @@ public:  // Signals
   * When the application is launched, this signal is emitted after the main loop of the application starts up.
   * The passed parameter describes the launch request and contains the information about why the application is launched.
   * @SINCE_1_0.0
+  * @return The signal to connect to
   */
   AppControlSignalType& AppControlSignal();
 
   /**
    * @brief This signal is emitted when the language is changed on the device.
    * @SINCE_1_0.0
+   * @return The signal to connect to
    */
   AppSignalType& LanguageChangedSignal();
 
   /**
   * @brief This signal is emitted when the region of the device is changed.
   * @SINCE_1_0.0
+  * @return The signal to connect to
   */
   AppSignalType& RegionChangedSignal();
 
   /**
   * @brief This signal is emitted when the battery level of the device is low.
   * @SINCE_1_0.0
+  * @return The signal to connect to
   */
   AppSignalType& BatteryLowSignal();
 
   /**
   * @brief This signal is emitted when the memory level of the device is low.
   * @SINCE_1_0.0
+  * @return The signal to connect to
   */
   AppSignalType& MemoryLowSignal();
 

diff --git a/adaptors/public-api/adaptor-framework/style-change.h b/adaptors/public-api/adaptor-framework/style-change.h
index 7f2722a..0cb0995 100644 (file)
--- a/adaptors/public-api/adaptor-framework/style-change.h
+++ b/adaptors/public-api/adaptor-framework/style-change.h
@@ -36,6 +36,10 @@ namespace Dali
 namespace StyleChange
 {
 
+/**
+ * @brief The type of StyleChange
+ * @SINCE_1_0.0
+ */
 enum Type
 {
   DEFAULT_FONT_CHANGE,      ///< Denotes that the default font has changed. @SINCE_1_0.0

diff --git a/adaptors/public-api/adaptor-framework/tts-player.h b/adaptors/public-api/adaptor-framework/tts-player.h
index 27b8a5e..c3a8340 100644 (file)
--- a/adaptors/public-api/adaptor-framework/tts-player.h
+++ b/adaptors/public-api/adaptor-framework/tts-player.h
@@ -154,6 +154,7 @@ public: // API
   /**
    * @brief Gets the current state of the player.
    * @SINCE_1_0.0
+   * @return The current TTS state
    * @pre The TtsPlayer needs to be initialized.
    */
   State GetState();

diff --git a/adaptors/public-api/adaptor-framework/window.h b/adaptors/public-api/adaptor-framework/window.h
index 0df8dae..7d9ad0d 100644 (file)
--- a/adaptors/public-api/adaptor-framework/window.h
+++ b/adaptors/public-api/adaptor-framework/window.h
@@ -206,12 +206,14 @@ public:
   /**
    * @brief Add an orientation to the list of available orientations.
    * @SINCE_1_0.0
+   * @param[in] orientation The available orientation to add
    */
   void AddAvailableOrientation( WindowOrientation orientation );
 
   /**
    * @brief Remove an orientation from the list of available orientations.
    * @SINCE_1_0.0
+   * @param[in] orientation The available orientation to remove
    */
   void RemoveAvailableOrientation( WindowOrientation orientation );
 
@@ -251,6 +253,7 @@ public: // Signals
   /**
    * @brief The user should connect to this signal to get a timing when indicator was shown / hidden.
    * @SINCE_1_0.0
+   * @return The signal to connect to
    */
   IndicatorSignalType& IndicatorVisibilityChangedSignal();