From 3c1e3d96db855ef9cf7d391a6fc016a268425ad4 Mon Sep 17 00:00:00 2001 From: "dongsug.song" Date: Mon, 14 Nov 2016 22:46:14 +0900 Subject: [PATCH] Revert "[3.0] Add missed doxygen documentation" This reverts commit dbbe326c4c5dd97df1796c8e59d6ed2a1231d8f0. Change-Id: I976e10a9da8a33ef12585e8f79e0f002d584b4ed --- 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, 9 insertions(+), 109 deletions(-) diff --git a/dali/public-api/actors/actor-enumerations.h b/dali/public-api/actors/actor-enumerations.h index 3855dad..f82e8bd 100644 --- a/dali/public-api/actors/actor-enumerations.h +++ b/dali/public-api/actors/actor-enumerations.h @@ -59,10 +59,6 @@ enum PositionInheritanceMode */ namespace Dimension { - /** - * @brief The type of Dimension - * @SINCE_1_0.0 - */ enum Type { WIDTH = 0x1, ///< Width dimension @SINCE_1_0.0 @@ -71,10 +67,6 @@ 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 @@ -87,10 +79,6 @@ 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 @@ -111,10 +99,6 @@ 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 @@ -129,10 +113,6 @@ namespace SizeScalePolicy */ namespace HorizontalAlignment { - /** - * @brief The type of HorizontalAlignment - * @SINCE_1_0.0 - */ enum Type { LEFT, ///< Align horizontally left @SINCE_1_0.0 @@ -147,10 +127,6 @@ namespace HorizontalAlignment */ namespace VerticalAlignment { - /** - * @brief The type of VerticalAlignment - * @SINCE_1_0.0 - */ enum Type { TOP, ///< Align vertically top @SINCE_1_0.0 @@ -165,10 +141,6 @@ 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 a9c1a00..df137c4 100644 --- a/dali/public-api/actors/custom-actor-impl.h +++ b/dali/public-api/actors/custom-actor-impl.h @@ -319,10 +319,7 @@ public: protected: // For derived classes - /** - * @brief Flags for the constructor - * @SINCE_1_0.0 - */ + // Flags for the constructor 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 83a2df6..30857f7 100644 --- a/dali/public-api/common/dali-vector.h +++ b/dali/public-api/common/dali-vector.h @@ -114,7 +114,6 @@ 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 e755202..9a775aa 100644 --- a/dali/public-api/common/intrusive-ptr.h +++ b/dali/public-api/common/intrusive-ptr.h @@ -80,7 +80,6 @@ public: /** * @brief Copy constructor. * @SINCE_1_0.0 - * @param[in] rhs Const reference to an IntrusivePtr */ IntrusivePtr( IntrusivePtr const& rhs ) : mPtr( rhs.mPtr ) { @@ -208,7 +207,6 @@ 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 1d11caa..5db82fb 100644 --- a/dali/public-api/events/gesture-detector.h +++ b/dali/public-api/events/gesture-detector.h @@ -144,7 +144,6 @@ 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 df19d54..fdc2091 100644 --- a/dali/public-api/events/pan-gesture-detector.h +++ b/dali/public-api/events/pan-gesture-detector.h @@ -268,7 +268,6 @@ 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 504829f..3cdfec2 100644 --- a/dali/public-api/events/touch-data.h +++ b/dali/public-api/events/touch-data.h @@ -89,7 +89,6 @@ 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 f8b9717..3d42806 100644 --- a/dali/public-api/images/image-operations.h +++ b/dali/public-api/images/image-operations.h @@ -49,10 +49,6 @@ 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 @@ -84,10 +80,6 @@ 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 991c9d8..5fb2bd4 100644 --- a/dali/public-api/images/native-image-interface.h +++ b/dali/public-api/images/native-image-interface.h @@ -99,7 +99,6 @@ 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 b75a4e5..fd830d8 100644 --- a/dali/public-api/images/pixel-data.h +++ b/dali/public-api/images/pixel-data.h @@ -40,10 +40,6 @@ 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 @@ -60,7 +56,6 @@ 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 e8a8faf..73e5f8e 100644 --- a/dali/public-api/math/radian.h +++ b/dali/public-api/math/radian.h @@ -284,7 +284,6 @@ 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 ead729a..9f8188e 100644 --- a/dali/public-api/math/uint-16-pair.h +++ b/dali/public-api/math/uint-16-pair.h @@ -162,8 +162,6 @@ 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 8e77c77..6af4e4e 100644 --- a/dali/public-api/object/any.h +++ b/dali/public-api/object/any.h @@ -104,8 +104,7 @@ public: * @brief Assigns a given value to the Any type. * * @SINCE_1_0.0 - * @param[in] value The given value - * @return A reference to this + * @param[in] value The given value. * @note If the types are different, then the current container will be re-created. * */ @@ -140,7 +139,6 @@ 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 5e92153..75a0c1b 100644 --- a/dali/public-api/object/base-handle.h +++ b/dali/public-api/object/base-handle.h @@ -158,8 +158,7 @@ public: * @brief Returns the type info for the Handle. * * @SINCE_1_0.0 - * @param[in] info The type information - * @return The type info + * @return The type info. */ bool GetTypeInfo(Dali::TypeInfo& info) const; @@ -287,9 +286,6 @@ 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) @@ -301,9 +297,6 @@ 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) @@ -315,9 +308,6 @@ 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 6bed9d4..b1c3112 100644 --- a/dali/public-api/object/base-object.h +++ b/dali/public-api/object/base-object.h @@ -75,13 +75,7 @@ public: public: // Not intended for application developers /** - * @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. + * @copydoc Dali::BaseHandle::DoConnectSignal */ 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 790043b..d2ffa7a 100644 --- a/dali/public-api/object/property-array.h +++ b/dali/public-api/object/property-array.h @@ -102,14 +102,12 @@ 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 fd6cbd1..81b1362 100644 --- a/dali/public-api/object/property-conditions.h +++ b/dali/public-api/object/property-conditions.h @@ -86,7 +86,6 @@ 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 41b807b..c530a02 100644 --- a/dali/public-api/object/property-map.h +++ b/dali/public-api/object/property-map.h @@ -117,7 +117,6 @@ 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() @@ -130,7 +129,6 @@ 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() @@ -143,7 +141,6 @@ 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 ef9af41..b6bcbb9 100644 --- a/dali/public-api/object/property-notification.h +++ b/dali/public-api/object/property-notification.h @@ -125,7 +125,6 @@ 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 a44f376..4f1d93c 100644 --- a/dali/public-api/object/type-registry.h +++ b/dali/public-api/object/type-registry.h @@ -163,7 +163,6 @@ 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 a974417..ae44725 100644 --- a/dali/public-api/render-tasks/render-task.h +++ b/dali/public-api/render-tasks/render-task.h @@ -509,7 +509,6 @@ 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 8e0f430..8eb5e0e 100644 --- a/dali/public-api/rendering/frame-buffer.h +++ b/dali/public-api/rendering/frame-buffer.h @@ -47,10 +47,6 @@ 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 6a9d849..ff4a38f 100644 --- a/dali/public-api/rendering/renderer.h +++ b/dali/public-api/rendering/renderer.h @@ -423,7 +423,6 @@ 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 7eaeeb5..5342b62 100644 --- a/dali/public-api/rendering/sampler.h +++ b/dali/public-api/rendering/sampler.h @@ -43,7 +43,6 @@ public: * @brief Creates a new Sampler object * * @SINCE_1_1.43 - * @return A handle to the Sampler */ static Sampler New(); @@ -103,8 +102,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 ); @@ -112,9 +111,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 4c28dad..7962ec3 100644 --- a/dali/public-api/rendering/shader.h +++ b/dali/public-api/rendering/shader.h @@ -78,10 +78,6 @@ 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 f6c71bf..4e51768 100644 --- a/dali/public-api/rendering/texture-set.h +++ b/dali/public-api/rendering/texture-set.h @@ -89,7 +89,6 @@ 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 add533c..e6e0ebf 100644 --- a/dali/public-api/signals/callback.h +++ b/dali/public-api/signals/callback.h @@ -340,14 +340,11 @@ 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 ); @@ -406,9 +403,6 @@ 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 ); @@ -422,7 +416,6 @@ 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 edd9b96..1ebf577 100644 --- a/dali/public-api/signals/functor-delegate.h +++ b/dali/public-api/signals/functor-delegate.h @@ -59,7 +59,6 @@ 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