Skip to content

Commit 6f1a3e5

Browse files
authored
Merge pull request #23 from TDuffinNTU/master
Fixed(?) a bunch of documentation comments that appear to be missing a '/'
2 parents b7b7dfe + 32b58de commit 6f1a3e5

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

lib/src/helpers/flutter_carousel_options.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -187,12 +187,12 @@ class CarouselOptions {
187187
final bool reverse;
188188

189189
///A ScrollBehavior that will be applied to this widget individually.
190-
//
191-
// Defaults to null, wherein the inherited ScrollBehavior is copied and modified to alter the viewport decoration, like Scrollbars.
192-
//
193-
// ScrollBehaviors also provide ScrollPhysics. If an explicit ScrollPhysics is provided in physics, it will take precedence, followed by scrollBehavior, and then the inherited ancestor ScrollBehavior.
194-
//
195-
// The ScrollBehavior of the inherited ScrollConfiguration will be modified by default to not apply a Scrollbar.
190+
///
191+
/// Defaults to null, wherein the inherited ScrollBehavior is copied and modified to alter the viewport decoration, like Scrollbars.
192+
///
193+
/// ScrollBehaviors also provide ScrollPhysics. If an explicit ScrollPhysics is provided in physics, it will take precedence, followed by scrollBehavior, and then the inherited ancestor ScrollBehavior.
194+
///
195+
/// The ScrollBehavior of the inherited ScrollConfiguration will be modified by default to not apply a Scrollbar.
196196
final ScrollBehavior? scrollBehavior;
197197

198198
/// The axis along which the page view scrolls.

lib/src/utils/flutter_carousel_utils.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/// Converts an index of a set size to the corresponding index of a collection of another size
22
/// as if they were circular.
33
///
4-
/// Takes a [position] from collection Foo, a [base] from where Foo's index originated
5-
/// and the [length] of a second collection Baa, for which the correlating index is sought.
4+
/// Takes a [position] from collection `Foo`, a [base] from where `Foo`'s index originated
5+
/// and the [length] of a second collection `Bar`, for which the correlating index is sought.
66
///
7-
/// For example; We have a Carousel of 10000(simulating infinity) but only 6 images.
7+
/// For example; We have a Carousel of 10000 (simulating infinity) but only 6 images.
88
/// We need to repeat the images to give the illusion of a never ending stream.
9-
/// By calling _getRealIndex with position and base we get an offset.
9+
/// By calling `getRealIndex` with position and base we get an offset.
1010
/// This offset modulo our length, 6, will return a number between 0 and 5, which represent the image
1111
/// to be placed in the given position.
1212
int getRealIndex(int position, int base, int? length) {

0 commit comments

Comments
 (0)