Revert "[3.0] Add missed doxygen documentation" 53/97653/1
authordongsug.song <dongsug.song@samsung.com>
Tue, 15 Nov 2016 00:14:30 +0000 (09:14 +0900)
committerdongsug.song <dongsug.song@samsung.com>
Tue, 15 Nov 2016 00:14:34 +0000 (09:14 +0900)
This reverts commit 1e3649764d928dcd1ad77666b4c1ef7230b55c67.

Change-Id: I68252dded84d71c322dea53eddb82d294f187936

adaptors/public-api/adaptor-framework/application.h
adaptors/public-api/adaptor-framework/style-change.h
adaptors/public-api/adaptor-framework/tts-player.h
adaptors/public-api/adaptor-framework/window.h

index 1d052e8ada9144d250c805e182b6747a5d4d460f..e690d9b60c2f1d01c9e607dbdff3d893cabda4d1 100644 (file)
@@ -128,7 +128,6 @@ public:
    * @SINCE_1_0.0
    * @PRIVLEVEL_PUBLIC
    * @PRIVILEGE_DISPLAY
-   * @return A handle to the Application
    */
   static Application New();
 
@@ -140,7 +139,6 @@ 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[] );
 
@@ -153,7 +151,6 @@ 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 );
@@ -168,7 +165,6 @@ 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 );
@@ -182,17 +178,14 @@ 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& application );
+  Application& operator=( const Application& applicaton );
 
   /**
    * @brief Destructor
@@ -221,7 +214,6 @@ 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);
 
@@ -318,7 +310,6 @@ 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();
 
@@ -326,7 +317,6 @@ 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();
 
@@ -334,7 +324,6 @@ 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();
 
@@ -342,21 +331,18 @@ 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();
 
@@ -366,35 +352,30 @@ 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();
 
index 0cb099539be4ab3b320c652574d533a5ea634493..7f2722a9509a91c881460d7b5e4182071f784ebb 100644 (file)
@@ -36,10 +36,6 @@ 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
index c3a8340b16860801507b436c1c36940f11a8fdb7..27b8a5e8dfadca146e711cf1dfda16fa8dffd205 100644 (file)
@@ -154,7 +154,6 @@ 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();
index 7d9ad0d3e1ecb165cfee70689b4c0f380fdcd85b..0df8dae84e5948337e5351152c34cfbb24cea37d 100644 (file)
@@ -206,14 +206,12 @@ 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 );
 
@@ -253,7 +251,6 @@ 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();