feat: ✨ Added documentation comments to Showcase and ShowCaseWidget
#298
Conversation
| @@ -35,49 +35,162 @@ import 'tooltip_widget.dart'; | |||
|
|
|||
| class Showcase extends StatefulWidget { | |||
| @override | |||
|
|
|||
| /// A key that is unique across the entire app. | |||
There was a problem hiding this comment.
Mention why we are using the key and how user can use it to start showcase.
lib/src/showcase.dart
Outdated
|
|
||
| /// ShapeBorder of the highlighted box when target widget will be showcased. | ||
| /// | ||
| /// Note: If [targetBorderRadius] is specified, this parameter is ignored. |
There was a problem hiding this comment.
This should be,
If [targetBorderRadius] is specified, this parameter will be ignored.
lib/src/showcase.dart
Outdated
| /// ``` | ||
| final ShapeBorder targetShapeBorder; | ||
|
|
||
| /// Radius of rectangle box when target widget will be showcased. |
There was a problem hiding this comment.
Correct the grammer,
Radius of rectangle box while target widget is being showcased.
lib/src/showcase.dart
Outdated
| final double overlayOpacity; | ||
|
|
||
| /// Custom tooltip when [Showcase.withWidget] is used | ||
| /// having fixed [height] and [width] |
There was a problem hiding this comment.
No need to mention height and width parameters.
lib/src/showcase.dart
Outdated
| final Widget? container; | ||
| final Color showcaseBackgroundColor; | ||
|
|
||
| /// Default tooltip background color |
There was a problem hiding this comment.
Replace this to,
Defines background color for tooltip widget.
Also, mention if this property will be ignored while using custom tooltip.
There was a problem hiding this comment.
tooltipBackgroundColor parameter has been removed from parameter of Showcase.withWidget (custom tooltip) so I think no need to mention that.
| final Color tooltipBackgroundColor; | ||
|
|
||
| /// Default tooltip text color | ||
| /// |
There was a problem hiding this comment.
Mention, Where this will be applied and and how it differs from titleTextStyle and description text style. As these two also can be used to provide text color.
lib/src/showcase.dart
Outdated
| final double? width; | ||
|
|
||
| /// The length of time the bouncing animation of tooltip should last. |
There was a problem hiding this comment.
The duration of time the bouncing animation of tooltip...
lib/src/showcase_widget.dart
Outdated
| /// Default to `false` | ||
| final bool enableAutoPlayLock; | ||
|
|
||
| /// Whether disabling bouncing/moving animation for all the tooltip |
lib/src/showcase_widget.dart
Outdated
| final bool disableMovingAnimation; | ||
|
|
||
| /// Whether disabling initial scale animation for all the default tooltip |
lib/src/showcase_widget.dart
Outdated
| @@ -125,6 +162,8 @@ class ShowCaseWidgetState extends State<ShowCaseWidget> { | |||
| } | |||
| } | |||
|
|
|||
| /// Completes showcase of given id and starts next one | |||
| /// otherwise will finish the entire showcase view | |||
| void completed(GlobalKey? id) { | |||
There was a problem hiding this comment.
This should be named as key instead of id.
HappyMakadiyaS
force-pushed
the
feature/doc-comments
branch
2 times, most recently
from
a7cf0d0 to
c8483dd
Compare
|
LGTM! |
HappyMakadiyaS
force-pushed
the
feature/doc-comments
branch
from
c8483dd to
313e70a
Compare
Description
Added Documentation comments to
ShowcaseandShowCaseWidgetclass parametersChecklist
fix:,feat:,docs:etc).docsand added dartdoc comments with///.examplesordocs.Breaking Change?