From 61861ef3dd5dd060a7373089e51caed56c814bed Mon Sep 17 00:00:00 2001 From: Seoyeon Kim Date: Tue, 22 Nov 2016 13:55:26 +0900 Subject: [PATCH] [3.0] Fix and add missed doxygen Change-Id: I044b9f90dc07b3ec560f35e5cfbd98fdc9b2526a Signed-off-by: Seoyeon Kim --- adaptors/tizen/key-grab.h | 4 ++-- adaptors/wearable/watch/watch-application.h | 9 +++++++++ adaptors/wearable/watch/watch-time.h | 4 ++++ 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/adaptors/tizen/key-grab.h b/adaptors/tizen/key-grab.h index ff310e5..56d6c05 100755 --- a/adaptors/tizen/key-grab.h +++ b/adaptors/tizen/key-grab.h @@ -113,7 +113,7 @@ DALI_IMPORT_API bool UngrabKey( Window window, Dali::KEY daliKey ); /** * @PLATFORM - * @brief Grabs the list of keys specfied by @Dali::Vector of keys for @a window in @Vector of grabModes. + * @brief Grabs the list of keys specfied by Dali::Vector of keys for @a window in Vector of grabModes. * * @details This function can be used for following example scenarios: * - TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app. @@ -133,7 +133,7 @@ DALI_IMPORT_API Dali::Vector GrabKeyList( Window window, const Dali::Vecto /** * @PLATFORM - * @brief Ungrabs the list of keys specfied by @Dali::Vector of keys for @a window. + * @brief Ungrabs the list of keys specfied by Dali::Vector of keys for @a window. * * @SINCE_1_2.0 * @PRIVLEVEL_PLATFORM diff --git a/adaptors/wearable/watch/watch-application.h b/adaptors/wearable/watch/watch-application.h index 705ef2f..8151061 100644 --- a/adaptors/wearable/watch/watch-application.h +++ b/adaptors/wearable/watch/watch-application.h @@ -104,6 +104,7 @@ public: /** * @brief This is the constructor for applications without an argument list. * @SINCE_1_1.37 + * @return A handle to the WatchApplication */ static WatchApplication New(); @@ -113,6 +114,7 @@ public: * @SINCE_1_1.37 * @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 WatchApplication */ static WatchApplication New( int* argc, char **argv[] ); @@ -123,6 +125,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 WatchApplication */ static WatchApplication New( int* argc, char **argv[], const std::string& stylesheet ); @@ -135,12 +138,15 @@ public: /** * @brief Copy Constructor * @SINCE_1_1.37 + * @param[in] implementation The WatchApplication implementation */ WatchApplication( const WatchApplication& implementation ); /** * @brief Assignment operator * @SINCE_1_1.37 + * @param[in] handle Handle to an object + * @return A reference to this */ WatchApplication& operator=( const WatchApplication& applicaton ); @@ -161,6 +167,7 @@ public: * @endcode * time(watch time handle) will not be available after returning this callback. It will be freed by the framework. * @SINCE_1_1.37 + * @return The signal to connect to */ WatchTimeSignal& TimeTickSignal(); @@ -174,6 +181,7 @@ public: * @SINCE_1_1.37 * @remarks http://tizen.org/privilege/alarm.set privilege is needed to receive ambient ticks at each minute. * The AmbientTickSignal() will be ignored if your app doesn't have the privilege + * @return The signal to connect to */ WatchTimeSignal& AmbientTickSignal(); @@ -185,6 +193,7 @@ public: * @endcode * ambient_mode If true the device enters the ambient mode, otherwise false * @SINCE_1_1.37 + * @return The signal to connect to */ WatchBoolSignal& AmbientChangedSignal(); diff --git a/adaptors/wearable/watch/watch-time.h b/adaptors/wearable/watch/watch-time.h index 0dc19e8..1a304b5 100644 --- a/adaptors/wearable/watch/watch-time.h +++ b/adaptors/wearable/watch/watch-time.h @@ -57,6 +57,7 @@ public: * @brief return current hour * * @SINCE_1_1.37 + * @return the current hour * @pre The WatchTime needs to be initialized. */ int GetHour() const; @@ -65,6 +66,7 @@ public: * @brief return current hour24 * * @SINCE_1_1.37 + * @return the current hour(the 24-hour clock) * @pre The WatchTime needs to be initialized. */ int GetHour24() const; @@ -73,6 +75,7 @@ public: * @brief return current minute * * @SINCE_1_1.37 + * @return the current minute * @pre The WatchTime needs to be initialized. */ int GetMinute() const; @@ -81,6 +84,7 @@ public: * @brief return current second * * @SINCE_1_1.37 + * @return the current second * @pre The WatchTime needs to be initialized. */ int GetSecond() const; -- 2.7.4