Skip to content

Commit 6aa0c4c

Browse files
feat: doxygen comments
1 parent 1f0e4b5 commit 6aa0c4c

3 files changed

Lines changed: 47 additions & 11 deletions

File tree

ui/components/material/cfmaterial_animation_factory.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -268,13 +268,13 @@ class CF_UI_EXPORT CFMaterialAnimationFactory : public ICFAnimationManagerFactor
268268
* Unlike createAnimation(), this method always creates a new
269269
* animation instance and does not use token-based lookup.
270270
*
271-
* @param value Pointer to the float property to animate.
272-
* Must remain valid for the lifetime of the animation.
273-
* @param from Start value of the animation.
274-
* @param to End value of the animation.
275-
* @param durationMs Duration of the animation in milliseconds.
276-
* @param easing Easing type for the animation.
277-
* @param targetWidget Optional target widget for repaint notifications.
271+
* @param[in] value Pointer to the float property to animate.
272+
* Must remain valid for the lifetime of the animation.
273+
* @param[in] from Start value of the animation.
274+
* @param[in] to End value of the animation.
275+
* @param[in] durationMs Duration of the animation in milliseconds.
276+
* @param[in] easing Easing type for the animation.
277+
* @param[in] targetWidget Optional target widget for repaint notifications.
278278
*
279279
* @return WeakPtr to the created animation, or invalid WeakPtr if:
280280
* - Global enabled is false

ui/components/material/cfmaterial_property_animation.h

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,8 @@ class CF_UI_EXPORT CFMaterialPropertyAnimation : public ICFAbstractAnimation {
8686
* @ingroup ui_components_material
8787
*/
8888
CFMaterialPropertyAnimation(float* value, float from, float to, int durationMs,
89-
base::Easing::Type easing = base::Easing::Type::EmphasizedDecelerate,
89+
base::Easing::Type easing =
90+
base::Easing::Type::EmphasizedDecelerate,
9091
QObject* parent = nullptr);
9192

9293
/**
@@ -106,10 +107,45 @@ class CF_UI_EXPORT CFMaterialPropertyAnimation : public ICFAbstractAnimation {
106107
// ICFAbstractAnimation Interface
107108
// =========================================================================
108109

110+
/**
111+
* @brief Start the animation.
112+
*
113+
* @param[in] dir Direction to play the animation.
114+
*
115+
* @since 0.1
116+
*/
109117
void start(Direction dir = Direction::Forward) override;
118+
119+
/**
120+
* @brief Pause the animation.
121+
*
122+
* @since 0.1
123+
*/
110124
void pause() override;
125+
126+
/**
127+
* @brief Stop the animation and reset to initial state.
128+
*
129+
* @since 0.1
130+
*/
111131
void stop() override;
132+
133+
/**
134+
* @brief Reverse the animation direction.
135+
*
136+
* @since 0.1
137+
*/
112138
void reverse() override;
139+
140+
/**
141+
* @brief Update animation state by delta time.
142+
*
143+
* @param[in] dt Delta time in milliseconds.
144+
*
145+
* @return true if animation is still running, false if finished.
146+
*
147+
* @since 0.1
148+
*/
113149
bool tick(int dt) override;
114150
cf::WeakPtr<ICFAbstractAnimation> GetWeakPtr() override {
115151
return weak_factory_.GetWeakPtr();
@@ -122,7 +158,7 @@ class CF_UI_EXPORT CFMaterialPropertyAnimation : public ICFAbstractAnimation {
122158
/**
123159
* @brief Set the target widget for repaint notifications.
124160
*
125-
* @details The widget will receive update() calls during animation
161+
* @details The widget receives update() calls during animation
126162
* to trigger repaints.
127163
*
128164
* @param[in] widget Target widget (may be nullptr).

ui/widget/material/widget/textarea/textarea.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ class CF_UI_EXPORT TextArea : public QTextEdit {
312312
* @return Maximum number of lines, or 0 for unlimited.
313313
*
314314
* @throws None
315-
* @note 0 means no maximum (scrollbar will appear).
315+
* @note 0 means no maximum (scrollbar appears).
316316
* @warning None
317317
* @since 0.1
318318
* @ingroup ui_widget_material_widget
@@ -325,7 +325,7 @@ class CF_UI_EXPORT TextArea : public QTextEdit {
325325
* @param[in] lines Maximum number of visible lines, or 0 for unlimited.
326326
*
327327
* @throws None
328-
* @note When set, the text area will grow up to this many lines.
328+
* @note When set, the text area grows up to this many lines.
329329
* @warning None
330330
* @since 0.1
331331
* @ingroup ui_widget_material_widget

0 commit comments

Comments
 (0)