From 638495740e3ddc49ada7ff96b40bf1c292df6514 Mon Sep 17 00:00:00 2001 From: Seoyeon Kim Date: Wed, 3 Aug 2016 16:14:44 +0900 Subject: [PATCH] [3.0] Add descriptions and example codes Change-Id: If6318c0234d7ab7dd590b01dbbe7a4668b817ae8 Signed-off-by: Seoyeon Kim --- adaptors/public-api/adaptor-framework/application.h | 6 ++++++ adaptors/public-api/adaptor-framework/native-image-source.h | 4 ++++ adaptors/public-api/adaptor-framework/tts-player.h | 4 ++-- adaptors/public-api/adaptor-framework/window.h | 9 ++++++--- 4 files changed, 18 insertions(+), 5 deletions(-) diff --git a/adaptors/public-api/adaptor-framework/application.h b/adaptors/public-api/adaptor-framework/application.h index 375fa0e..3be6593 100644 --- a/adaptors/public-api/adaptor-framework/application.h +++ b/adaptors/public-api/adaptor-framework/application.h @@ -145,6 +145,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 + * @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 ); @@ -156,6 +157,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 + * @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 ); @@ -277,7 +279,10 @@ public: // Stereoscopy /** * @brief Set 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. * @SINCE_1_0.0 + * @remarks SetStereoBase() is supported in mobile applications only. * @param[in] stereoBase The stereo base (eye separation) for Stereoscopic 3D */ void SetStereoBase( float stereoBase ); @@ -286,6 +291,7 @@ public: // Stereoscopy * @brief Get the stereo base (eye separation) for Stereoscopic 3D * * @SINCE_1_0.0 + * @remarks GetStereoBase() is supported in mobile applications only. * @return The stereo base (eye separation) for Stereoscopic 3D */ float GetStereoBase() const; diff --git a/adaptors/public-api/adaptor-framework/native-image-source.h b/adaptors/public-api/adaptor-framework/native-image-source.h index a6258ce..effacce 100755 --- a/adaptors/public-api/adaptor-framework/native-image-source.h +++ b/adaptors/public-api/adaptor-framework/native-image-source.h @@ -53,8 +53,11 @@ typedef Dali::IntrusivePtr NativeImageSourcePtr; * * NativeImageSource can be created internally or * externally by native image source. + * NativeImage is a platform specific way of providing pixel data to the GPU for rendering, + * for example via an EGL image. * * @SINCE_1_1.4 + * @see NativeImage */ class DALI_IMPORT_API NativeImageSource : public NativeImageInterface { @@ -91,6 +94,7 @@ public: * @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. + * @see NativeImageInterface */ static NativeImageSourcePtr New( Any nativeImageSource ); diff --git a/adaptors/public-api/adaptor-framework/tts-player.h b/adaptors/public-api/adaptor-framework/tts-player.h index f233f15..27b8a5e 100644 --- a/adaptors/public-api/adaptor-framework/tts-player.h +++ b/adaptors/public-api/adaptor-framework/tts-player.h @@ -52,8 +52,8 @@ public: // ENUMs enum Mode { DEFAULT = 0, ///< Default mode for normal application @SINCE_1_0.0 - NOTIFICATION, ///< Notification mode @SINCE_1_0.0 - SCREEN_READER, ///< Screen reader mode @SINCE_1_0.0 + NOTIFICATION, ///< Notification mode, such as playing utterance is started or completed @SINCE_1_0.0 + SCREEN_READER, ///< Screen reader mode. To help visually impaired users interact with their devices, screen reader reads text or graphic elements on the screen using the TTS engine. @SINCE_1_0.0 MODE_NUM }; diff --git a/adaptors/public-api/adaptor-framework/window.h b/adaptors/public-api/adaptor-framework/window.h index 5bfe0ca..0df8dae 100644 --- a/adaptors/public-api/adaptor-framework/window.h +++ b/adaptors/public-api/adaptor-framework/window.h @@ -63,13 +63,13 @@ public: // Enumerations /** - * @brief Orientation of the window. + * @brief Orientation of the window is the way in which a rectangular page is oriented for normal viewing. * @SINCE_1_0.0 */ enum WindowOrientation { - PORTRAIT = 0, ///< Portrait orientation @SINCE_1_0.0 - LANDSCAPE = 90, ///< Landscape orientation @SINCE_1_0.0 + PORTRAIT = 0, ///< Portrait orientation. The height of the display area is greater than the width. @SINCE_1_0.0 + LANDSCAPE = 90, ///< Landscape orientation. A wide view area is needed. @SINCE_1_0.0 PORTRAIT_INVERSE = 180, ///< Portrait inverse orientation @SINCE_1_0.0 LANDSCAPE_INVERSE = 270 ///< Landscape inverse orientation @SINCE_1_0.0 }; @@ -232,6 +232,7 @@ 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. */ @@ -239,6 +240,8 @@ public: /** * @brief Get 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. */ -- 2.7.4