Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed(?) a bunch of documentation comments that appear to be missing a '/' #23

Merged
merged 2 commits into from
Jun 20, 2023
Merged

Fixed(?) a bunch of documentation comments that appear to be missing a '/' #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89dc774
Fixed(?) a bunch of documentation comments that appear to be missing a /
Jun 19, 2023
32b58de
small typo fixes and improvements for viewing via intellisense.
Jun 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions lib/src/helpers/flutter_carousel_options.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,12 +187,12 @@ class CarouselOptions {
final bool reverse;

///A ScrollBehavior that will be applied to this widget individually.
//
// Defaults to null, wherein the inherited ScrollBehavior is copied and modified to alter the viewport decoration, like Scrollbars.
//
// 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.
//
// The ScrollBehavior of the inherited ScrollConfiguration will be modified by default to not apply a Scrollbar.
///
/// Defaults to null, wherein the inherited ScrollBehavior is copied and modified to alter the viewport decoration, like Scrollbars.
///
/// 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.
///
/// The ScrollBehavior of the inherited ScrollConfiguration will be modified by default to not apply a Scrollbar.
final ScrollBehavior? scrollBehavior;

/// The axis along which the page view scrolls.
Expand Down
8 changes: 4 additions & 4 deletions lib/src/utils/flutter_carousel_utils.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
/// Converts an index of a set size to the corresponding index of a collection of another size
/// as if they were circular.
///
/// Takes a [position] from collection Foo, a [base] from where Foo's index originated
/// and the [length] of a second collection Baa, for which the correlating index is sought.
/// Takes a [position] from collection `Foo`, a [base] from where `Foo`'s index originated
/// and the [length] of a second collection `Bar`, for which the correlating index is sought.
///
/// For example; We have a Carousel of 10000(simulating infinity) but only 6 images.
/// For example; We have a Carousel of 10000 (simulating infinity) but only 6 images.
/// We need to repeat the images to give the illusion of a never ending stream.
/// By calling _getRealIndex with position and base we get an offset.
/// By calling `getRealIndex` with position and base we get an offset.
/// This offset modulo our length, 6, will return a number between 0 and 5, which represent the image
/// to be placed in the given position.
int getRealIndex(int position, int base, int? length) {
Expand Down