Skip to content

Commit

Permalink
chore: update dartdoc to use backticks for code formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
tsinis committed Feb 9, 2025
1 parent ed6cb55 commit 098c95d
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
8 changes: 4 additions & 4 deletions packages/world_flags/lib/src/constants/flag_constants.dart
Original file line number Diff line number Diff line change
Expand Up @@ -45,20 +45,20 @@ sealed class FlagConstants {
/// The default aspect ratio for flags.
///
/// This value is used as the standard aspect ratio for most flags. The
/// default aspect ratio is 3:2, meaning the width is 1.5 times the height.
/// default aspect ratio is `3:2`, meaning the width is 1.5 times the height.
static const defaultAspectRatio = 3 / 2;

/// The minimum aspect ratio for flags.
///
/// This value represents the smallest aspect ratio used by any country's
/// flag. The minimum aspect ratio is 41:50, which is the aspect ratio of the
/// flag of Nepal.
/// flag. The minimum aspect ratio is `41:50`, which is the aspect ratio of
/// the flag of Nepal.
static const minAspectRatio = 41 / 50; // Nepal.

/// The maximum aspect ratio for flags.
///
/// This value represents the largest aspect ratio used by any country's flag.
/// The maximum aspect ratio is 28:11, which is the aspect ratio of the flag
/// The maximum aspect ratio is `28:11`, which is the aspect ratio of the flag
/// of Qatar.
static const maxAspectRatio = 28 / 11; // Qatar.
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import "../../model/flag_properties.dart";
import "../../model/typedefs.dart";
import "../../ui/flags/basic_flag.dart";

/// An extension on [BasicFlag] to provide a `copyWith` method for creating a
/// An extension on [BasicFlag] to provide a [copyWith] method for creating a
/// new instance of [BasicFlag] with modified properties.
///
/// This extension allows you to create a new [BasicFlag] by copying the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import "package:flutter/rendering.dart";

/// An extension on [BoxDecoration] to provide additional utility methods.
///
/// This extension adds a `isCircle` getter to check if the shape of the
/// This extension adds a [isCircle] getter to check if the shape of the
/// [BoxDecoration] is a circle.
///
/// Example usage:
Expand Down
6 changes: 3 additions & 3 deletions packages/world_flags/lib/src/model/colors_properties.dart
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class ColorsProperties {
/// Creates a new instance of [ColorsProperties].
///
/// The [color] parameter is required and specifies the color of the element.
/// The [ratio] parameter is optional and defaults to 1. It must be greater
/// The [ratio] parameter is optional and defaults to `1`. It must be greater
/// than or equal to zero.
const ColorsProperties(this.color, {this.ratio = 1})
: assert(ratio >= 0, "`ratio` must be greater than or equal to zero.");
Expand All @@ -40,7 +40,7 @@ class ColorsProperties {
/// representation of a color.
///
/// The [bitColor] parameter is required and specifies the color in integer
/// format. The [ratio] parameter is optional and defaults to 1. It must be
/// format. The [ratio] parameter is optional and defaults to `1`. It must be
/// greater than or equal to zero.
@visibleForTesting
ColorsProperties.fromIntColor(int bitColor, {this.ratio = 1})
Expand All @@ -51,7 +51,7 @@ class ColorsProperties {
final Color color;

/// The ratio associated with the color, typically used for flags stripes.
/// For example in the Germany all three colors have the same ratio of 1.
/// For example in the Germany all three colors have the same ratio of `1`.
///
/// This value must be greater than or equal to zero.
final int ratio;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class CustomElementsProperties extends ElementsProperties {

/// A list of additional colors for the element.
///
/// This list can be used to specify secondary colors or other color
/// This list can be used to specify secondary colors or other [Color]
/// variations for the flag element.
final List<Color> otherColors;
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class ElementsProperties {
/// [offset] parameter specifies the distance fraction in the horizontal and
/// vertical directions from the center. It defaults to [Offset.zero]. The
/// [heightFactor] parameter specifies the height factor of the element and
/// defaults to 1. The [widthFactor] parameter specifies the width factor of
/// defaults to `1`. The [widthFactor] parameter specifies the width factor of
/// the element and is optional. The [angle] parameter specifies the rotation
/// angle of the element in degrees and is optional. The [child] parameter
/// specifies a potential child element and is optional.
Expand All @@ -58,9 +58,9 @@ class ElementsProperties {
/// The distance fraction in the horizontal/vertical direction (of the
/// center).
///
/// A value of -1.0 corresponds to the leftmost/topmost edge. A value of 1.0
/// corresponds to the rightmost/bottommost edge. Values are not limited to
/// that range.
/// A value of `-1.0` corresponds to the leftmost/topmost edge. A value of
/// `1.0` corresponds to the rightmost/bottommost edge. Values are not limited
/// to that range.
final Offset offset;

/// The primary color of the element.
Expand Down

0 comments on commit 098c95d

Please sign in to comment.