From dbbe326c4c5dd97df1796c8e59d6ed2a1231d8f0 Mon Sep 17 00:00:00 2001 From: Seoyeon Kim Date: Fri, 23 Sep 2016 13:41:39 +0900 Subject: [PATCH] [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: Iba5275921c2c1fc47d1b3d3cfd2aa01f3a153979 Signed-off-by: Seoyeon Kim --- dali/public-api/actors/actor-enumerations.h | 28 +++++++++++++++++++++++++ dali/public-api/actors/custom-actor-impl.h | 5 ++++- dali/public-api/common/dali-vector.h | 1 + dali/public-api/common/intrusive-ptr.h | 2 ++ dali/public-api/events/gesture-detector.h | 1 + dali/public-api/events/pan-gesture-detector.h | 1 + dali/public-api/events/touch-data.h | 1 + dali/public-api/images/image-operations.h | 8 +++++++ dali/public-api/images/native-image-interface.h | 1 + dali/public-api/images/pixel-data.h | 5 +++++ dali/public-api/math/radian.h | 1 + dali/public-api/math/uint-16-pair.h | 2 ++ dali/public-api/object/any.h | 4 +++- dali/public-api/object/base-handle.h | 12 ++++++++++- dali/public-api/object/base-object.h | 8 ++++++- dali/public-api/object/property-array.h | 2 ++ dali/public-api/object/property-conditions.h | 1 + dali/public-api/object/property-map.h | 3 +++ dali/public-api/object/property-notification.h | 1 + dali/public-api/object/type-registry.h | 1 + dali/public-api/render-tasks/render-task.h | 1 + dali/public-api/rendering/frame-buffer.h | 4 ++++ dali/public-api/rendering/renderer.h | 1 + dali/public-api/rendering/sampler.h | 11 +++++----- dali/public-api/rendering/shader.h | 4 ++++ dali/public-api/rendering/texture-set.h | 1 + dali/public-api/signals/callback.h | 7 +++++++ dali/public-api/signals/functor-delegate.h | 1 + 28 files changed, 109 insertions(+), 9 deletions(-) diff --git a/dali/public-api/actors/actor-enumerations.h b/dali/public-api/actors/actor-enumerations.h index f82e8bd..3855dad 100644 --- a/dali/public-api/actors/actor-enumerations.h +++ b/dali/public-api/actors/actor-enumerations.h @@ -59,6 +59,10 @@ enum PositionInheritanceMode */ namespace Dimension { + /** + * @brief The type of Dimension + * @SINCE_1_0.0 + */ enum Type { WIDTH = 0x1, ///< Width dimension @SINCE_1_0.0 @@ -67,6 +71,10 @@ namespace Dimension ALL_DIMENSIONS = 0x3 ///< Mask to cover all flags @SINCE_1_0.0 }; + /** + * @brief The number of dimensions + * @SINCE_1_0.0 + */ enum Meta { DIMENSION_COUNT = 2 ///< Number of dimensions - update this if adding new dimension @SINCE_1_0.0 @@ -79,6 +87,10 @@ namespace Dimension */ namespace ResizePolicy { + /** + * @brief The type of ResizePolicy + * @SINCE_1_0.0 + */ enum Type { FIXED, ///< Size is fixed as set by SetSize @SINCE_1_0.0 @@ -99,6 +111,10 @@ namespace ResizePolicy */ namespace SizeScalePolicy { + /** + * @brief The type of SizeScalePolicy + * @SINCE_1_0.0 + */ enum Type { USE_SIZE_SET, ///< Use the size that was set @SINCE_1_0.0 @@ -113,6 +129,10 @@ namespace SizeScalePolicy */ namespace HorizontalAlignment { + /** + * @brief The type of HorizontalAlignment + * @SINCE_1_0.0 + */ enum Type { LEFT, ///< Align horizontally left @SINCE_1_0.0 @@ -127,6 +147,10 @@ namespace HorizontalAlignment */ namespace VerticalAlignment { + /** + * @brief The type of VerticalAlignment + * @SINCE_1_0.0 + */ enum Type { TOP, ///< Align vertically top @SINCE_1_0.0 @@ -141,6 +165,10 @@ namespace VerticalAlignment */ namespace ClippingMode { + /** + * @brief The type of ClippingMode + * @SINCE_1_2_5 + */ enum Type { DISABLED, ///< This Actor will not clip its children. @SINCE_1_2_5 diff --git a/dali/public-api/actors/custom-actor-impl.h b/dali/public-api/actors/custom-actor-impl.h index df137c4..a9c1a00 100644 --- a/dali/public-api/actors/custom-actor-impl.h +++ b/dali/public-api/actors/custom-actor-impl.h @@ -319,7 +319,10 @@ public: protected: // For derived classes - // Flags for the constructor + /** + * @brief Flags for the constructor + * @SINCE_1_0.0 + */ enum ActorFlags { ACTOR_BEHAVIOUR_NONE = 0, diff --git a/dali/public-api/common/dali-vector.h b/dali/public-api/common/dali-vector.h index 30857f7..83a2df6 100644 --- a/dali/public-api/common/dali-vector.h +++ b/dali/public-api/common/dali-vector.h @@ -114,6 +114,7 @@ public: // API /** * @brief @ return If the vector is empty * @SINCE_1_0.0 + * @return true if the count of elements is empty */ bool Empty() const { diff --git a/dali/public-api/common/intrusive-ptr.h b/dali/public-api/common/intrusive-ptr.h index 9a775aa..e755202 100644 --- a/dali/public-api/common/intrusive-ptr.h +++ b/dali/public-api/common/intrusive-ptr.h @@ -80,6 +80,7 @@ public: /** * @brief Copy constructor. * @SINCE_1_0.0 + * @param[in] rhs Const reference to an IntrusivePtr */ IntrusivePtr( IntrusivePtr const& rhs ) : mPtr( rhs.mPtr ) { @@ -207,6 +208,7 @@ public: * * Use with care. * @SINCE_1_0.0 + * @return Pointer to reference counted object */ T* Detach() { diff --git a/dali/public-api/events/gesture-detector.h b/dali/public-api/events/gesture-detector.h index 5db82fb..1d11caa 100644 --- a/dali/public-api/events/gesture-detector.h +++ b/dali/public-api/events/gesture-detector.h @@ -144,6 +144,7 @@ public: // Actor related * @brief Returns an actor by index. An empty handle if the index is not valid. * * @SINCE_1_0.0 + * @param[in] index The attached actor's index * @return The attached actor or an empty handle. * @pre The gesture detector has been initialized. */ diff --git a/dali/public-api/events/pan-gesture-detector.h b/dali/public-api/events/pan-gesture-detector.h index fdc2091..df19d54 100644 --- a/dali/public-api/events/pan-gesture-detector.h +++ b/dali/public-api/events/pan-gesture-detector.h @@ -268,6 +268,7 @@ public: // Directional Panning * @brief Returns the angle by index that this pan gesture detector emits a signal. * * @SINCE_1_0.0 + * @param[in] index The angle's index * @return An angle threshold pair, or a zero valued angle pair when index is invalid. * @pre The gesture detector has been initialized. * @pre The index is less than GetAngleCount() diff --git a/dali/public-api/events/touch-data.h b/dali/public-api/events/touch-data.h index 3cdfec2..504829f 100644 --- a/dali/public-api/events/touch-data.h +++ b/dali/public-api/events/touch-data.h @@ -89,6 +89,7 @@ public: * * @SINCE_1_1.37 * @param[in] other The TouchData to copy from. + * @return A reference to this */ TouchData& operator=( const TouchData& other ); diff --git a/dali/public-api/images/image-operations.h b/dali/public-api/images/image-operations.h index 3d42806..f8b9717 100644 --- a/dali/public-api/images/image-operations.h +++ b/dali/public-api/images/image-operations.h @@ -49,6 +49,10 @@ typedef Dali::Uint16Pair ImageDimensions; */ namespace FittingMode { + /** + * @brief The type of FittingMode + * @SINCE_1_0.0 + */ enum Type { SHRINK_TO_FIT, ///< Fit full image inside desired width & height, potentially not @SINCE_1_0.0 @@ -80,6 +84,10 @@ namespace FittingMode */ namespace SamplingMode { + /** + * @brief The type of SamplingMode + * @SINCE_1_0.0 + */ enum Type { BOX, ///< Iteratively box filter to generate an image of 1/2, 1/4, @SINCE_1_0.0 diff --git a/dali/public-api/images/native-image-interface.h b/dali/public-api/images/native-image-interface.h index 5fb2bd4..991c9d8 100644 --- a/dali/public-api/images/native-image-interface.h +++ b/dali/public-api/images/native-image-interface.h @@ -99,6 +99,7 @@ public: /** * @brief Query whether blending is required * @SINCE_1_0.0 + * @return true if blending is required */ virtual bool RequiresBlending() const = 0; diff --git a/dali/public-api/images/pixel-data.h b/dali/public-api/images/pixel-data.h index fd830d8..b75a4e5 100644 --- a/dali/public-api/images/pixel-data.h +++ b/dali/public-api/images/pixel-data.h @@ -40,6 +40,10 @@ class DALI_IMPORT_API PixelData : public BaseHandle { public: + /** + * @brief Function to release the pixel buffer + * @SINCE_1_1.43 + */ enum ReleaseFunction { FREE, ///< Use free function to release the pixel buffer @SINCE_1_1.43 @@ -56,6 +60,7 @@ public: * @param[in] height Buffer height in pixels * @param[in] pixelFormat The pixel format * @param[in] releaseFunction The function used to release the memory. + * @return A handle to the PixelData */ static PixelData New( unsigned char* buffer, unsigned int bufferSize, diff --git a/dali/public-api/math/radian.h b/dali/public-api/math/radian.h index 73e5f8e..e8a8faf 100644 --- a/dali/public-api/math/radian.h +++ b/dali/public-api/math/radian.h @@ -284,6 +284,7 @@ inline Radian operator*( Radian lhs, float rhs ) /** * @brief Negate the radian * @SINCE_1_0.0 + * @param[in] in Radian to negate * @return The negative angle */ inline Radian operator-( Radian in ) diff --git a/dali/public-api/math/uint-16-pair.h b/dali/public-api/math/uint-16-pair.h index 9f8188e..ead729a 100644 --- a/dali/public-api/math/uint-16-pair.h +++ b/dali/public-api/math/uint-16-pair.h @@ -162,6 +162,8 @@ public: /** * @brief Assignment operator. * @SINCE_1_0.0 + * @param[in] rhs Handle to an object + * @return A reference to this */ Uint16Pair& operator=( const Uint16Pair& rhs ) { diff --git a/dali/public-api/object/any.h b/dali/public-api/object/any.h index 6af4e4e..8e77c77 100644 --- a/dali/public-api/object/any.h +++ b/dali/public-api/object/any.h @@ -104,7 +104,8 @@ public: * @brief Assigns a given value to the Any type. * * @SINCE_1_0.0 - * @param[in] value The given value. + * @param[in] value The given value + * @return A reference to this * @note If the types are different, then the current container will be re-created. * */ @@ -139,6 +140,7 @@ public: * * @SINCE_1_0.0 * @param [in] any Any to be assigned which contains a value of identical type to current contents. + * @return A reference to this * @exception DaliException If parameter any is of a different type. * */ diff --git a/dali/public-api/object/base-handle.h b/dali/public-api/object/base-handle.h index 75a0c1b..5e92153 100644 --- a/dali/public-api/object/base-handle.h +++ b/dali/public-api/object/base-handle.h @@ -158,7 +158,8 @@ public: * @brief Returns the type info for the Handle. * * @SINCE_1_0.0 - * @return The type info. + * @param[in] info The type information + * @return The type info */ bool GetTypeInfo(Dali::TypeInfo& info) const; @@ -286,6 +287,9 @@ inline T DownCast( BaseHandle handle ) /** * @brief Equality operator * @SINCE_1_0.0 + * @param[in] lhs A reference to compare + * @param[in] rhs A reference to compare to + * @return true if the handle handles point to the same Dali resource, or if both are NULL */ template inline bool operator==(const BaseHandle& lhs, const T& rhs) @@ -297,6 +301,9 @@ inline bool operator==(const BaseHandle& lhs, const T& rhs) /** * @brief Equality operator * @SINCE_1_0.0 + * @param[in] lhs A reference to compare + * @param[in] rhs A reference to compare to + * @return true if the handle handles point to the different Dali resources */ template inline bool operator!=(const BaseHandle& lhs, const T& rhs) @@ -308,6 +315,9 @@ inline bool operator!=(const BaseHandle& lhs, const T& rhs) /** * @brief Less than operator * @SINCE_1_0.0 + * @param[in] lhs A reference to compare + * @param[in] rhs A reference to compare to + * @return true if lhs less than rhs */ inline bool operator<(const BaseHandle& lhs, const BaseHandle& rhs) { diff --git a/dali/public-api/object/base-object.h b/dali/public-api/object/base-object.h index b1c3112..6bed9d4 100644 --- a/dali/public-api/object/base-object.h +++ b/dali/public-api/object/base-object.h @@ -75,7 +75,13 @@ public: public: // Not intended for application developers /** - * @copydoc Dali::BaseHandle::DoConnectSignal + * @brief Not intended for application developers. + * + * @SINCE_1_0.0 + * @param [in] connectionTracker A connection tracker which can be used to disconnect. + * @param [in] signalName Name of the signal to connect to. + * @param [in] functorDelegate A newly allocatated functor delegate (takes ownership). + * @return True if the signal was available. */ bool DoConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functorDelegate ); diff --git a/dali/public-api/object/property-array.h b/dali/public-api/object/property-array.h index d2ffa7a..790043b 100644 --- a/dali/public-api/object/property-array.h +++ b/dali/public-api/object/property-array.h @@ -102,12 +102,14 @@ public: /** * @brief Increase the capcity of the array. * @SINCE_1_0.0 + * @param[in] size The size to reserve */ void Reserve( SizeType size ); /** * @brief Resize to size. * @SINCE_1_0.0 + * @param[in] size The size to resize */ void Resize( SizeType size ); diff --git a/dali/public-api/object/property-conditions.h b/dali/public-api/object/property-conditions.h index 81b1362..fd6cbd1 100644 --- a/dali/public-api/object/property-conditions.h +++ b/dali/public-api/object/property-conditions.h @@ -86,6 +86,7 @@ public: * @brief Retrieve the arguments that this condition uses. * * @SINCE_1_0.0 + * @param[in] index The condition index to get the argument * @return The arguments used for this condition * @note The container will only be valid as long PropertyCondition is valid. */ diff --git a/dali/public-api/object/property-map.h b/dali/public-api/object/property-map.h index c530a02..41b807b 100644 --- a/dali/public-api/object/property-map.h +++ b/dali/public-api/object/property-map.h @@ -117,6 +117,7 @@ public: * @brief Retrieve the value of the string-value pair at the specified position. * * @SINCE_1_0.0 + * @param[in] position The specified position * @return A reference to the value at the specified position. * * @note Will assert if position >= Count() @@ -129,6 +130,7 @@ public: * @brief Retrieve the key at the specified position. * * @SINCE_1_0.0 + * @param[in] position The specified position * @return A const reference to the key at the specified position. * * @note Will assert if position >= Count() @@ -141,6 +143,7 @@ public: * @brief Retrieve the key & the value at the specified position. * * @SINCE_1_0.0 + * @param[in] position The specified position * @return A reference to the pair of key and value at the specified position. * * @note Will assert if position >= Count() diff --git a/dali/public-api/object/property-notification.h b/dali/public-api/object/property-notification.h index b6bcbb9..ef9af41 100644 --- a/dali/public-api/object/property-notification.h +++ b/dali/public-api/object/property-notification.h @@ -125,6 +125,7 @@ public: /** * @brief Get the target handle that this notification is observing. * @SINCE_1_0.0 + * @return The target handle */ Dali::Handle GetTarget() const; diff --git a/dali/public-api/object/type-registry.h b/dali/public-api/object/type-registry.h index 4f1d93c..a44f376 100644 --- a/dali/public-api/object/type-registry.h +++ b/dali/public-api/object/type-registry.h @@ -163,6 +163,7 @@ public: * @brief Get type names by index. * * @SINCE_1_0.0 + * @param[in] index The index to get the type name * @return The type name or an empty string when index is not valid */ std::string GetTypeName(size_t index) const; diff --git a/dali/public-api/render-tasks/render-task.h b/dali/public-api/render-tasks/render-task.h index ae44725..a974417 100644 --- a/dali/public-api/render-tasks/render-task.h +++ b/dali/public-api/render-tasks/render-task.h @@ -509,6 +509,7 @@ public: // Signals /** * @brief If the refresh rate is REFRESH_ONCE, connect to this signal to be notified when a RenderTask has finished. * @SINCE_1_0.0 + * @return The signal to connect to */ RenderTaskSignalType& FinishedSignal(); diff --git a/dali/public-api/rendering/frame-buffer.h b/dali/public-api/rendering/frame-buffer.h index 8eb5e0e..8e0f430 100644 --- a/dali/public-api/rendering/frame-buffer.h +++ b/dali/public-api/rendering/frame-buffer.h @@ -47,6 +47,10 @@ public: */ struct Attachment { + /** + * @brief The bit-mask value + * @SINCE_1_1.45 + */ enum Mask { NONE = 0, ///< No attachments are created initially @SINCE_1_1.45 diff --git a/dali/public-api/rendering/renderer.h b/dali/public-api/rendering/renderer.h index ff4a38f..6a9d849 100644 --- a/dali/public-api/rendering/renderer.h +++ b/dali/public-api/rendering/renderer.h @@ -423,6 +423,7 @@ public: * @SINCE_1_1.43 * @param[in] geometry Geometry to be used by this renderer * @param[in] shader Shader to be used by this renderer + * @return A handle to the Renderer */ static Renderer New( Geometry& geometry, Shader& shader ); diff --git a/dali/public-api/rendering/sampler.h b/dali/public-api/rendering/sampler.h index 5342b62..7eaeeb5 100644 --- a/dali/public-api/rendering/sampler.h +++ b/dali/public-api/rendering/sampler.h @@ -43,6 +43,7 @@ public: * @brief Creates a new Sampler object * * @SINCE_1_1.43 + * @return A handle to the Sampler */ static Sampler New(); @@ -102,8 +103,8 @@ public: * @brief Set the wrap modes for this sampler * * @SINCE_1_1.43 - * param[in] uWrap Wrap mode for u coordinates - * param[in] vWrap Wrap mode for v coordinates + * @param[in] uWrap Wrap mode for u coordinates + * @param[in] vWrap Wrap mode for v coordinates */ void SetWrapMode( WrapMode::Type uWrap, WrapMode::Type vWrap ); @@ -111,9 +112,9 @@ public: * @brief Set the wrap modes for this sampler * * @SINCE_1_1.43 - * param[in] rWrap Wrap mode for the z direction - * param[in] sWrap Wrap mode for the x direction - * param[in] tWrap Wrap mode for the y direction + * @param[in] rWrap Wrap mode for the z direction + * @param[in] sWrap Wrap mode for the x direction + * @param[in] tWrap Wrap mode for the y direction */ void SetWrapMode( WrapMode::Type rWrap, WrapMode::Type sWrap, WrapMode::Type tWrap ); diff --git a/dali/public-api/rendering/shader.h b/dali/public-api/rendering/shader.h index 7962ec3..4c28dad 100644 --- a/dali/public-api/rendering/shader.h +++ b/dali/public-api/rendering/shader.h @@ -78,6 +78,10 @@ public: */ struct Hint { + /** + * @brief Hint value + * @SINCE_1_1.45 + */ enum Value { NONE = 0x00, ///< No hints @SINCE_1_1.45 diff --git a/dali/public-api/rendering/texture-set.h b/dali/public-api/rendering/texture-set.h index 4e51768..f6c71bf 100644 --- a/dali/public-api/rendering/texture-set.h +++ b/dali/public-api/rendering/texture-set.h @@ -89,6 +89,7 @@ public: * * @SINCE_1_1.43 * @param[in] handle Handle to an object + * @return A reference to this */ TextureSet& operator=( const TextureSet& handle ); diff --git a/dali/public-api/signals/callback.h b/dali/public-api/signals/callback.h index e6e0ebf..add533c 100644 --- a/dali/public-api/signals/callback.h +++ b/dali/public-api/signals/callback.h @@ -340,11 +340,14 @@ protected: // Constructors for deriving classes /** * @brief Copy constructor operator not declared. * @SINCE_1_0.0 + * @param[in] rhs Handle to an object */ CallbackBase( const CallbackBase& rhs ); /** * @brief assignment operator not declared. * @SINCE_1_0.0 + * @param[in] rhs Handle to an object + * @return A reference to this */ const CallbackBase& operator=( const CallbackBase& rhs ); @@ -403,6 +406,9 @@ public: // Data for deriving classes & Dispatchers /** * @brief Non-member equality operator * @SINCE_1_0.0 + * @param[in] lhs A reference to compare + * @param[in] rhs A reference to compare to + * @return true if lhs is same as rhs */ bool operator==( const CallbackBase& lhs, const CallbackBase& rhs ); @@ -416,6 +422,7 @@ struct Destroyer /** * @brief Dispatcher to delete an object. * @SINCE_1_0.0 + * @param[in] object An object to delete */ static void Delete( void* object ) { diff --git a/dali/public-api/signals/functor-delegate.h b/dali/public-api/signals/functor-delegate.h index 1ebf577..edd9b96 100644 --- a/dali/public-api/signals/functor-delegate.h +++ b/dali/public-api/signals/functor-delegate.h @@ -59,6 +59,7 @@ struct FunctorDestroyer /** * @brief Dispatcher to delete an object * @SINCE_1_0.0 + * @param[in] functorPtr A functor object to delete */ static void Delete( void* functorPtr ) { -- 2.7.4