From a7573b0f44b096f3118714fd88089b900cae917e Mon Sep 17 00:00:00 2001 From: Seoyeon Kim Date: Wed, 8 Feb 2017 12:33:43 +0900 Subject: [PATCH 1/1] [3.0] Update doxygen comments - For document public release, Native API reference is checked by Lionbridge. Change-Id: I8a601c16f08f87072e18e809e64d2790e767e31d Signed-off-by: Seoyeon Kim --- .../adaptor-framework/application-configuration.h | 4 +- .../public-api/adaptor-framework/application.h | 54 ++++++++--------- .../public-api/adaptor-framework/input-method.h | 8 +-- adaptors/public-api/adaptor-framework/key.h | 8 +-- .../adaptor-framework/native-image-source.h | 62 +++++++++---------- .../public-api/adaptor-framework/style-change.h | 4 +- adaptors/public-api/adaptor-framework/timer.h | 34 +++++------ adaptors/public-api/adaptor-framework/tts-player.h | 22 +++---- adaptors/public-api/adaptor-framework/window.h | 69 +++++++++++----------- adaptors/tizen/key-grab.h | 22 +++---- 10 files changed, 143 insertions(+), 144 deletions(-) diff --git a/adaptors/public-api/adaptor-framework/application-configuration.h b/adaptors/public-api/adaptor-framework/application-configuration.h index d745cb8..c5b2c9e 100644 --- a/adaptors/public-api/adaptor-framework/application-configuration.h +++ b/adaptors/public-api/adaptor-framework/application-configuration.h @@ -25,14 +25,14 @@ namespace Dali */ /** - * @brief Application configuration enumerations + * @brief Enumeration for Application configuration. * @SINCE_1_0.0 */ namespace Configuration { /** - * @brief Enumeration about application context loss policy + * @brief Enumeration for application context loss policy. * @SINCE_1_0.0 */ enum ContextLoss diff --git a/adaptors/public-api/adaptor-framework/application.h b/adaptors/public-api/adaptor-framework/application.h index 1d052e8..827cee7 100644 --- a/adaptors/public-api/adaptor-framework/application.h +++ b/adaptors/public-api/adaptor-framework/application.h @@ -47,7 +47,7 @@ class Application; * @brief An Application class object should be created by every application * that wishes to use Dali. * - * It provides a means for initialising the + * It provides a means for initializing the * resources required by the Dali::Core. * * The Application class emits several signals which the user can @@ -112,7 +112,7 @@ public: typedef Signal< void (Application&, void *) > AppControlSignalType; ///< Application control signal callback type @SINCE_1_0.0 /** - * @brief Decides whether a Dali application window is opaque or transparent. + * @brief Enumeration for deciding whether a Dali application window is opaque or transparent. * @SINCE_1_0.0 */ enum WINDOW_MODE @@ -139,19 +139,19 @@ public: * @PRIVLEVEL_PUBLIC * @PRIVILEGE_DISPLAY * @param[in,out] argc A pointer to the number of arguments - * @param[in,out] argv A pointer the the argument list + * @param[in,out] argv A pointer to the argument list * @return A handle to the Application */ static Application New( int* argc, char **argv[] ); /** - * @brief This is the constructor for applications with a name + * @brief This is the constructor for applications with a name. * * @SINCE_1_0.0 * @PRIVLEVEL_PUBLIC * @PRIVILEGE_DISPLAY * @param[in,out] argc A pointer to the number of arguments - * @param[in,out] argv A pointer the the argument list + * @param[in,out] argv A pointer to 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. @@ -159,13 +159,13 @@ public: static Application New( int* argc, char **argv[], const std::string& stylesheet ); /** - * @brief This is the constructor for applications with a name + * @brief This is the constructor for applications with a name. * * @SINCE_1_0.0 * @PRIVLEVEL_PUBLIC * @PRIVILEGE_DISPLAY * @param[in,out] argc A pointer to the number of arguments - * @param[in,out] argv A pointer the the argument list + * @param[in,out] argv A pointer to 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 @@ -174,20 +174,20 @@ public: static Application New( int* argc, char **argv[], const std::string& stylesheet, WINDOW_MODE windowMode ); /** - * @brief Construct an empty handle + * @brief Constructs an empty handle. * @SINCE_1_0.0 */ Application(); /** - * @brief Copy Constructor + * @brief Copy Constructor. * @SINCE_1_0.0 * @param[in] application Handle to an object */ Application( const Application& application ); /** - * @brief Assignment operator + * @brief Assignment operator. * @SINCE_1_0.0 * @param[in] application Handle to an object * @return A reference to this @@ -195,7 +195,7 @@ public: Application& operator=( const Application& application ); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. * @SINCE_1_0.0 @@ -226,7 +226,7 @@ public: void MainLoop(Configuration::ContextLoss configuration); /** - * @brief This lowers the application to bottom without actually quitting it + * @brief This lowers the application to bottom without actually quitting it. * @SINCE_1_0.0 */ void Lower(); @@ -240,8 +240,8 @@ public: /** * @brief Ensures that the function passed in is called from the main loop when it is idle. * @SINCE_1_0.0 - * @param[in] callback The function to call. - * @return true if added successfully, false otherwise + * @param[in] callback The function to call + * @return @c true if added successfully, @c false otherwise * * @note Function must be called from main event thread only * @@ -265,11 +265,11 @@ public: Window GetWindow(); /** - * @brief Replace the current window. + * @brief Replaces the current window. * * This will force context loss. * If you plan on using this API in your application, then you should configure - * it to prevent discard behaviour when handling the Init signal. + * it to prevent discard behavior when handling the Init signal. * @SINCE_1_0.0 * @param[in] windowPosition The position and size parameters of the new window * @param[in] name The name of the new window @@ -279,21 +279,21 @@ public: public: // Stereoscopy /** - * @brief Set the viewing mode for the application. + * @brief Sets the viewing mode for the application. * @SINCE_1_0.0 - * @param[in] viewMode The new viewing mode. + * @param[in] viewMode The new viewing mode */ void SetViewMode( ViewMode viewMode ); /** - * @brief Get the current viewing mode. + * @brief Gets the current viewing mode. * @SINCE_1_0.0 - * @return The current viewing mode. + * @return The current viewing mode */ ViewMode GetViewMode() const; /** - * @brief Set the stereo base (eye separation) for Stereoscopic 3D + * @brief Sets the stereo base (eye separation) for Stereoscopic 3D. * * The stereo base is the distance in millimetres between the eyes. Typical values are * between 50mm and 70mm. The default value is 65mm. @@ -304,7 +304,7 @@ public: // Stereoscopy void SetStereoBase( float stereoBase ); /** - * @brief Get the stereo base (eye separation) for Stereoscopic 3D + * @brief Gets the stereo base (eye separation) for Stereoscopic 3D. * * @SINCE_1_0.0 * @remarks GetStereoBase() is supported in mobile applications only. @@ -315,7 +315,7 @@ public: // Stereoscopy public: // Signals /** - * @brief The user should connect to this signal to determine when they should initialise + * @brief The user should connect to this signal to determine when they should initialize * their application. * @SINCE_1_0.0 * @return The signal to connect to @@ -324,7 +324,7 @@ public: // Signals /** * @brief The user should connect to this signal to determine when they should terminate - * their application + * their application. * @SINCE_1_0.0 * @return The signal to connect to */ @@ -347,14 +347,14 @@ public: // Signals AppSignalType& ResumeSignal(); /** - * @brief This signal is sent when the system requires the user to reinitialise itself. + * @brief This signal is sent when the system requires the user to reinitialize 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. + * @brief This signal is emitted when the window application rendering on is resized. * @SINCE_1_0.0 * @return The signal to connect to */ @@ -401,7 +401,7 @@ public: // Signals public: // Not intended for application developers /** * @internal - * @brief Internal constructor + * @brief Internal constructor. * @SINCE_1_0.0 */ explicit DALI_INTERNAL Application(Internal::Adaptor::Application* application); diff --git a/adaptors/public-api/adaptor-framework/input-method.h b/adaptors/public-api/adaptor-framework/input-method.h index dfa4517..5d38abc 100644 --- a/adaptors/public-api/adaptor-framework/input-method.h +++ b/adaptors/public-api/adaptor-framework/input-method.h @@ -29,13 +29,13 @@ namespace Dali */ /** - * @brief Enumerations for input method + * @brief Enumeration for input method. * @SINCE_1_0.0 */ namespace InputMethod { /** - * @brief Specifies what the Input Method "action" button functionality is set to. + * @brief Enumeration for specifying what the Input Method "action" button functionality is set to. * * The 'Action' button is traditionally the [RETURN] or [DONE] button. * @@ -61,7 +61,7 @@ enum ActionButton }; /** - * @brief Settings that can be changed in the system Input Method + * @brief Enumeration for settings that can be changed in the system Input Method. * * Not all these settings are supported by all systems. * @SINCE_1_0.0 @@ -69,7 +69,7 @@ enum ActionButton enum Settings { ACTION_BUTTON, ///< ActionButton. Apply the one of the ActionButton functions to the action button (return button). @SINCE_1_0.0 - AUTO_CAPITALISE, ///< boolean. Capitalise the first letter of each sentence automatically. @SINCE_1_0.0 + AUTO_CAPITALISE, ///< boolean. Capitalize the first letter of each sentence automatically. @SINCE_1_0.0 AUTO_COMPLETE, ///< boolean. Suggest words based on the current input. @SINCE_1_0.0 AUTO_CORRECT ///< boolean. Automatically correct commonly misspelt words. @SINCE_1_0.0 }; diff --git a/adaptors/public-api/adaptor-framework/key.h b/adaptors/public-api/adaptor-framework/key.h index 49f6553..76ab11e 100644 --- a/adaptors/public-api/adaptor-framework/key.h +++ b/adaptors/public-api/adaptor-framework/key.h @@ -30,7 +30,7 @@ namespace Dali */ /** - * @brief Mapping of keyboard and mouse button event keycodes to platform specific codes. + * @brief Enumeration for mapping keyboard and mouse button event keycodes to platform specific codes. * @SINCE_1_0.0 */ @@ -81,12 +81,12 @@ enum KEY }; /** - * @brief Check if a key event is for a specific DALI KEY. + * @brief Checks if a key event is for a specific DALI KEY. * * @SINCE_1_0.0 * @param keyEvent reference to a keyEvent structure - * @param daliKey dali key enum - * @return true if the key is matched, false if not + * @param daliKey Dali key enum + * @return @c true if the key is matched, @c false if not */ DALI_IMPORT_API bool IsKey( const Dali::KeyEvent& keyEvent, Dali::KEY daliKey); diff --git a/adaptors/public-api/adaptor-framework/native-image-source.h b/adaptors/public-api/adaptor-framework/native-image-source.h index effacce..0f9f1b2 100755 --- a/adaptors/public-api/adaptor-framework/native-image-source.h +++ b/adaptors/public-api/adaptor-framework/native-image-source.h @@ -64,7 +64,7 @@ class DALI_IMPORT_API NativeImageSource : public NativeImageInterface public: /** - * @brief When creating a native image the color depth has to be specified. + * @brief Enumeration for the instance when creating a native image, the color depth has to be specified. * @SINCE_1_0.0 */ enum ColorDepth @@ -77,63 +77,63 @@ public: }; /** - * @brief Create a new NativeImageSource. + * @brief Creates a new NativeImageSource. * - * Depending on hardware the width and height may have to be a power of two. + * Depending on hardware, the width and height may have to be a power of two. * @SINCE_1_0.0 - * @param[in] width The width of the image. - * @param[in] height The height of the image. - * @param[in] depth color depth of the image. - * @return A smart-pointer to a newly allocated image. + * @param[in] width The width of the image + * @param[in] height The height of the image + * @param[in] depth color depth of the image + * @return A smart-pointer to a newly allocated image */ static NativeImageSourcePtr New( unsigned int width, unsigned int height, ColorDepth depth ); /** - * @brief Create a new NativeImageSource from an existing native image source. + * @brief Creates a new NativeImageSource from an existing native image source. * * @SINCE_1_0.0 - * @param[in] nativeImageSource must be a any handle with native image source - * @return A smart-pointer to a newly allocated image. + * @param[in] nativeImageSource NativeImageSource must be a any handle with native image source + * @return A smart-pointer to a newly allocated image * @see NativeImageInterface */ static NativeImageSourcePtr New( Any nativeImageSource ); /** - * @brief Retrieve the internal native image. + * @brief Retrieves the internal native image. * * @SINCE_1_0.0 - * @return Any object containing the internal native image source. + * @return Any object containing the internal native image source */ Any GetNativeImageSource(); /** - * @brief Get a copy of the pixels used by NativeImageSource. + * @brief Gets a copy of the pixels used by NativeImageSource. * * This is only supported for 24 bit RGB and 32 bit RGBA internal formats * (COLOR_DEPTH_24 and COLOR_DEPTH_32). * @SINCE_1_0.0 - * @param[out] pixbuf a vector to store the pixels in - * @param[out] width The width of image + * @param[out] pixbuf A vector to store the pixels in + * @param[out] width The width of image * @param[out] height The height of image * @param[out] pixelFormat pixel format used by image - * @return True if the pixels were gotten, and false otherwise. + * @return @c true if the pixels were gotten, and @c false otherwise */ bool GetPixels( std::vector& pixbuf, unsigned int& width, unsigned int& height, Pixel::Format& pixelFormat ) const; /** - * @brief Convert the current pixel contents to either a JPEG or PNG format + * @brief Converts the current pixel contents to either a JPEG or PNG format * and write that to the filesytem. * * @SINCE_1_0.0 - * @param[in] filename Identify the filesytem location at which to write the - * encoded image. The extension determines the encoding used. + * @param[in] filename Identify the filesytem location at which to write the encoded image. + * The extension determines the encoding used. * The two valid encoding are (".jpeg"|".jpg") and ".png". - * @return True if the pixels were written, and false otherwise. + * @return @c true if the pixels were written, and @c false otherwise */ bool EncodeToFile(const std::string& filename) const; /** - * @brief Set an existing source + * @brief Sets an existing source. * * @SINCE_1_1.19 * @param[in] source Any handle with the source @@ -141,11 +141,11 @@ public: void SetSource( Any source ); /** - * @brief Check if the specified color depth is supported. + * @brief Checks if the specified color depth is supported. * * @SINCE_1_1.34 - * @param[in] colorDepth The color depth to check. - * @return true if colorDepth is supported, false otherwise. + * @param[in] colorDepth The color depth to check + * @return @c true if colorDepth is supported, @c false otherwise */ bool IsColorDepthSupported( ColorDepth colorDepth ); @@ -195,11 +195,11 @@ private: /** * @internal - * @brief Private constructor + * @brief Private constructor. * @SINCE_1_0.0 - * @param[in] width The width of the image. - * @param[in] height The height of the image. - * @param[in] depth color depth of the image. + * @param[in] width The width of the image + * @param[in] height The height of the image + * @param[in] depth color depth of the image * @param[in] nativeImageSource contains either: native image source or is empty */ DALI_INTERNAL NativeImageSource( unsigned int width, unsigned int height, ColorDepth depth, Any nativeImageSource ); @@ -215,11 +215,11 @@ private: /** * @internal - * @brief Undefined copy constructor + * @brief Undefined copy constructor. * * This avoids accidental calls to a default copy constructor. * @SINCE_1_0.0 - * @param[in] nativeImageSource A reference to the object to copy. + * @param[in] nativeImageSource A reference to the object to copy */ DALI_INTERNAL NativeImageSource( const NativeImageSource& nativeImageSource ); @@ -229,7 +229,7 @@ private: * * This avoids accidental calls to a default assignment operator. * @SINCE_1_0.0 - * @param[in] rhs A reference to the object to copy. + * @param[in] rhs A reference to the object to copy */ DALI_INTERNAL NativeImageSource& operator=(const NativeImageSource& rhs); diff --git a/adaptors/public-api/adaptor-framework/style-change.h b/adaptors/public-api/adaptor-framework/style-change.h index 0cb0995..e38bf63 100644 --- a/adaptors/public-api/adaptor-framework/style-change.h +++ b/adaptors/public-api/adaptor-framework/style-change.h @@ -30,14 +30,14 @@ namespace Dali */ /** - * @brief Style change information. + * @brief Enumeration for style change information. * @SINCE_1_0.0 */ namespace StyleChange { /** - * @brief The type of StyleChange + * @brief Enumeration for StyleChange type. * @SINCE_1_0.0 */ enum Type diff --git a/adaptors/public-api/adaptor-framework/timer.h b/adaptors/public-api/adaptor-framework/timer.h index cbf4a01..472ae02 100644 --- a/adaptors/public-api/adaptor-framework/timer.h +++ b/adaptors/public-api/adaptor-framework/timer.h @@ -68,11 +68,11 @@ public: // API Timer(); /** - * @brief Create an tick Timer that emits periodic signal. + * @brief Creates a tick Timer that emits periodic signal. * * @SINCE_1_0.0 - * @param[in] milliSec Interval in milliseconds. - * @return a new timer + * @param[in] milliSec Interval in milliseconds + * @return A new timer */ static Timer New( unsigned int milliSec ); @@ -89,13 +89,13 @@ public: // API * * @SINCE_1_0.0 * @param[in] timer The handle to copy. This handle will point at the same implementation - * as the copied handle. + * as the copied handle * @return Reference to this timer handle */ Timer& operator=( const Timer& timer ); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. * @SINCE_1_0.0 @@ -103,10 +103,10 @@ public: // API ~Timer(); /** - * @brief Downcast a handle to Timer handle. + * @brief Downcasts a handle to Timer handle. * - * If handle points to a Timer object the downcast produces a valid - * handle. If not the returned handle is left uninitialized. + * If handle points to a Timer object, the downcast produces a valid handle. + * If not, the returned handle is left uninitialized. * * @SINCE_1_0.0 * @param[in] handle to An object @@ -115,15 +115,15 @@ public: // API static Timer DownCast( BaseHandle handle ); /** - * @brief Start timer. + * @brief Starts timer. * - * In case a Timer is already running it's time is reset and timer is restarted. + * In case a Timer is already running, its time is reset and timer is restarted. * @SINCE_1_0.0 */ void Start(); /** - * @brief Stop timer. + * @brief Stops timer. * @SINCE_1_0.0 */ void Stop(); @@ -133,22 +133,22 @@ public: // API * * Cancels the previous timer. * @SINCE_1_0.0 - * @param[in] milliSec Interval in milliseconds. + * @param[in] milliSec Interval in milliseconds */ void SetInterval( unsigned int milliSec ); /** - * @brief Get the interval of timer. + * @brief Gets the interval of timer. * - * @return Interval in milliseconds. * @SINCE_1_0.0 + * @return Interval in milliseconds */ unsigned int GetInterval() const; /** - * @brief Tells whether timer is running. + * @brief Tells whether timer is running. * @SINCE_1_0.0 - * @return Whether Timer is started or not. + * @return Whether Timer is started or not */ bool IsRunning() const; @@ -160,7 +160,7 @@ public: // Signals * The return of the callback decides whether signal emission stops or continues. * If the callback function returns false, emission will stop and if true, it will continue. * This return value is ignored for one-shot events, which will always stop after the first execution. - * @return The signal to Connect() with. + * @return The signal to Connect() with * @SINCE_1_0.0 */ TimerSignalType& TickSignal(); diff --git a/adaptors/public-api/adaptor-framework/tts-player.h b/adaptors/public-api/adaptor-framework/tts-player.h index c3a8340..7914cfd 100644 --- a/adaptors/public-api/adaptor-framework/tts-player.h +++ b/adaptors/public-api/adaptor-framework/tts-player.h @@ -46,7 +46,7 @@ class DALI_IMPORT_API TtsPlayer : public BaseHandle public: // ENUMs /** - * @brief Enumeration of TTS mode. + * @brief Enumeration for the instance of TTS mode. * @SINCE_1_0.0 */ enum Mode @@ -58,7 +58,7 @@ public: // ENUMs }; /** - * @brief Enumeration of TTS state. + * @brief Enumeration for the instance of TTS state. * @SINCE_1_0.0 */ enum State @@ -80,7 +80,7 @@ public: // Typedefs public: // API /** - * @brief Create an uninitialized handle. + * @brief Creates an uninitialized handle. * * This can be initialized by calling TtsPlayer::Get(). * @SINCE_1_0.0 @@ -91,13 +91,13 @@ public: // API * @brief Gets the singleton of the TtsPlayer for the given mode. * * @SINCE_1_0.0 - * @param mode the mode of tts-player - * @return A handle of the Ttsplayer for the given mode. + * @param mode The mode of tts-player + * @return A handle of the Ttsplayer for the given mode */ static TtsPlayer Get(Dali::TtsPlayer::Mode mode = Dali::TtsPlayer::DEFAULT); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. * @SINCE_1_0.0 @@ -116,16 +116,16 @@ public: // API * @brief This assignment operator is required for (smart) pointer semantics. * * @SINCE_1_0.0 - * @param [in] rhs A reference to the copied handle + * @param [in] rhs A reference to the copied handle * @return A reference to this */ TtsPlayer& operator=(const TtsPlayer& rhs); /** - * @brief Start playing the audio data synthesized from the specified text. + * @brief Starts playing the audio data synthesized from the specified text. * * @SINCE_1_0.0 - * @param[in] text to play. + * @param[in] text The text to play * @pre The TtsPlayer needs to be initialized. */ void Play(const std::string& text); @@ -162,7 +162,7 @@ public: // API /** * @brief Allows connection TTS state change signal. * @SINCE_1_0.0 - * @return A reference to the signal for connection. + * @return A reference to the signal for connection * @note Only supported by some adaptor types. */ Dali::TtsPlayer::StateChangedSignalType& StateChangedSignal(); @@ -173,7 +173,7 @@ public: // Not intended for application developers * @internal * @brief This constructor is used by TtsPlayer::Get(). * @SINCE_1_0.0 - * @param[in] ttsPlayer A pointer to the TTS player. + * @param[in] ttsPlayer A pointer to the TTS player */ explicit DALI_INTERNAL TtsPlayer( Internal::Adaptor::TtsPlayer* ttsPlayer ); }; diff --git a/adaptors/public-api/adaptor-framework/window.h b/adaptors/public-api/adaptor-framework/window.h index 7d9ad0d..56ca8f5 100644 --- a/adaptors/public-api/adaptor-framework/window.h +++ b/adaptors/public-api/adaptor-framework/window.h @@ -63,7 +63,7 @@ public: // Enumerations /** - * @brief Orientation of the window is the way in which a rectangular page is oriented for normal viewing. + * @brief Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing. * @SINCE_1_0.0 */ enum WindowOrientation @@ -75,7 +75,7 @@ public: }; /** - * @brief Opacity of the indicator. + * @brief Enumeration for opacity of the indicator. * @SINCE_1_0.0 */ enum IndicatorBgOpacity @@ -86,7 +86,7 @@ public: }; /** - * @brief Visible mode of the indicator. + * @brief Enumeration for visible mode of the indicator. * @SINCE_1_0.0 */ enum IndicatorVisibleMode @@ -99,37 +99,37 @@ public: // Methods /** - * @brief Create an initialized handle to a new Window. + * @brief Creates an initialized handle to a new Window. * @SINCE_1_0.0 - * @param[in] windowPosition The position and size of the window - * @param[in] name The window title - * @param[in] isTransparent Whether window is transparent - * @return a new window + * @param[in] windowPosition The position and size of the Window + * @param[in] name The Window title + * @param[in] isTransparent Whether Window is transparent + * @return A new window */ static Window New(PositionSize windowPosition, const std::string& name, bool isTransparent = false); /** - * @brief Create an initialized handle to a new Window. + * @brief Creates an initialized handle to a new Window. * @SINCE_1_0.0 - * @param[in] windowPosition The position and size of the window - * @param[in] name The window title - * @param[in] className The window class name - * @param[in] isTransparent Whether window is transparent - * @return a new window + * @param[in] windowPosition The position and size of the Window + * @param[in] name The Window title + * @param[in] className The Window class name + * @param[in] isTransparent Whether Window is transparent + * @return A new Window */ static Window New(PositionSize windowPosition, const std::string& name, const std::string& className, bool isTransparent = false); /** - * @brief Create an uninitalized handle. + * @brief Creates an uninitialized handle. * * This can be initialized using Dali::Application::GetWindow() or - * Dali::Window::New() + * Dali::Window::New(). * @SINCE_1_0.0 */ Window(); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. * @SINCE_1_0.0 @@ -140,7 +140,7 @@ public: * @brief This copy constructor is required for (smart) pointer semantics. * * @SINCE_1_0.0 - * @param [in] handle A reference to the copied handle + * @param[in] handle A reference to the copied handle */ Window(const Window& handle); @@ -148,7 +148,7 @@ public: * @brief This assignment operator is required for (smart) pointer semantics. * * @SINCE_1_0.0 - * @param [in] rhs A reference to the copied handle + * @param[in] rhs A reference to the copied handle * @return A reference to this */ Window& operator=(const Window& rhs); @@ -170,15 +170,14 @@ public: /** * @brief This sets the orientation of indicator bar. * - * It does not implicitly show the indicator if it is currently - * hidden. + * It does not implicitly show the indicator if it is currently hidden. * @SINCE_1_0.0 * @param[in] orientation The orientation */ void RotateIndicator(WindowOrientation orientation); /** - * @brief Set the window name and class string. + * @brief Sets the window name and class string. * @SINCE_1_0.0 * @param[in] name The name of the window * @param[in] klass The class of the window @@ -186,49 +185,49 @@ public: void SetClass(std::string name, std::string klass); /** - * @brief Raise window to top of window stack. + * @brief Raises window to the top of Window stack. * @SINCE_1_0.0 */ void Raise(); /** - * @brief Lower window to bottom of window stack. + * @brief Lowers window to the bottom of Window stack. * @SINCE_1_0.0 */ void Lower(); /** - * @brief Activate window to top of window stack even it is iconified. + * @brief Activates window to the top of Window stack even it is iconified. * @SINCE_1_0.0 */ void Activate(); /** - * @brief Add an orientation to the list of available orientations. + * @brief Adds 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. + * @brief Removes an orientation from the list of available orientations. * @SINCE_1_0.0 * @param[in] orientation The available orientation to remove */ void RemoveAvailableOrientation( WindowOrientation orientation ); /** - * @brief Set a preferred orientation. + * @brief Sets a preferred orientation. * @SINCE_1_0.0 * @param[in] orientation The preferred orientation - * @pre orientation is in the list of available orientations + * @pre Orientation is in the list of available orientations. */ void SetPreferredOrientation( WindowOrientation orientation ); /** - * @brief Get the preferred orientation. + * @brief Gets the preferred orientation. * @SINCE_1_0.0 - * @return The preferred orientation if previously set, or none. + * @return The preferred orientation if previously set, or none */ WindowOrientation GetPreferredOrientation(); @@ -236,16 +235,16 @@ public: * @brief Returns the Drag & drop detector which can be used to receive drag & drop events. * @note Not intended for application developers. * @SINCE_1_0.0 - * @return A handle to the DragAndDropDetector. + * @return A handle to the DragAndDropDetector */ DragAndDropDetector GetDragAndDropDetector() const; /** - * @brief Get the native handle of the window. + * @brief Gets the native handle of the window. * * When users call this function, it wraps the actual type used by the underlying window system. * @SINCE_1_0.0 - * @return The native handle of the window or an empty handle. + * @return The native handle of the Window or an empty handle */ Any GetNativeHandle() const; @@ -262,7 +261,7 @@ public: // Not intended for application developers * @internal * @brief This constructor is used by Dali::Application::GetWindow(). * @SINCE_1_0.0 - * @param[in] window A pointer to the window. + * @param[in] window A pointer to the Window */ explicit DALI_INTERNAL Window( Internal::Adaptor::Window* window ); }; diff --git a/adaptors/tizen/key-grab.h b/adaptors/tizen/key-grab.h index 56d6c05..d7d3bdc 100755 --- a/adaptors/tizen/key-grab.h +++ b/adaptors/tizen/key-grab.h @@ -40,7 +40,7 @@ namespace KeyGrab { /** - * @brief Grabs the key specfied by @a key for @a window only when @a window is the topmost window. + * @brief Grabs the key specified by @a key for @a window only when @a window is the topmost window. * * This function can be used for following example scenarios: * - Mobile - Using volume up/down as zoom up/down in camera apps. @@ -48,24 +48,24 @@ namespace KeyGrab * @SINCE_1_0.0 * @param[in] window The window to set * @param[in] daliKey The key code to grab (defined in key.h) - * @return true if the grab succeeds. + * @return true if the grab succeeds */ DALI_IMPORT_API bool GrabKeyTopmost( Window window, Dali::KEY daliKey ); /** - * @brief Ungrabs the key specfied by @a key for @a window. + * @brief Ungrabs the key specified by @a key for @a window. * * @SINCE_1_0.0 * @param[in] window The window to set * @param[in] daliKey The key code to ungrab (defined in key.h) - * @return true if the ungrab succeeds. + * @return true if the ungrab succeeds * @note If this function is called between key down and up events of a grabbed key, * an application doesn't receive the key up event. */ DALI_IMPORT_API bool UngrabKeyTopmost( Window window, Dali::KEY daliKey ); /** - * @brief Key grab mode for platform-level APIs. + * @brief Enumeration for key grab mode for platform-level APIs. * @SINCE_1_0.0 */ enum KeyGrabMode @@ -78,7 +78,7 @@ enum KeyGrabMode /** * @PLATFORM - * @brief Grabs the key specfied by @a key for @a window in @a grabMode. + * @brief Grabs the key specified by @a key for @a window in @a grabMode. * * @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. @@ -91,20 +91,20 @@ enum KeyGrabMode * @param[in] window The window to set * @param[in] daliKey The key code to grab (defined in key.h) * @param[in] grabMode The grab mode for the key - * @return true if the grab succeeds. + * @return true if the grab succeeds */ DALI_IMPORT_API bool GrabKey( Window window, Dali::KEY daliKey, KeyGrabMode grabMode ); /** * @PLATFORM - * @brief Ungrabs the key specfied by @a key for @a window. + * @brief Ungrabs the key specified by @a key for @a window. * * @SINCE_1_0.0 * @PRIVLEVEL_PLATFORM * @PRIVILEGE_KEYGRAB * @param[in] window The window to set * @param[in] daliKey The key code to ungrab (defined in key.h) - * @return true if the ungrab succeeds. + * @return true if the ungrab succeeds * @note If this function is called between key down and up events of a grabbed key, * an application doesn't receive the key up event. */ @@ -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 specified 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 specified by Dali::Vector of keys for @a window. * * @SINCE_1_2.0 * @PRIVLEVEL_PLATFORM -- 2.7.4