Skip to content

Commit

Permalink
docs: proper(short) first sentence of doc-comments (#110)
Browse files Browse the repository at this point in the history
  • Loading branch information
daadu authored Dec 19, 2021
1 parent 048a187 commit 4ab4db7
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions lib/src/sub_header.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import 'package:backdrop/backdrop.dart';
import 'package:flutter/material.dart';

/// A wrapper for adding a sub-header to the used backdrop front layer(s).
///
/// This class can be passed to [BackdropScaffold] to specify the sub-header
/// that should be shown while the front layer is "inactive" (the back layer is
/// "showing").
Expand Down Expand Up @@ -31,30 +32,30 @@ class BackdropSubHeader extends StatelessWidget {
/// Defaults to `EdgeInsets.symmetric(vertical: 12.0, horizontal: 16.0)`.
final EdgeInsets padding;

/// Flag indicating whether the leading widget for the sub-header should be
/// automatically determined by [BackdropSubHeader].
/// Flag indicating whether to add default leading widget.
///
/// If set to `true`, a leading `Icon(Icons.keyboard_arrow_up)` is added to
/// the sub-header.
///
/// Defaults to `false`.
final bool automaticallyImplyLeading;

/// Flag indicating whether the trailing widget for the sub-header should be
/// automatically determined by [BackdropSubHeader].
/// Flag indicating whether to add default trailing widget.
///
/// If set to `true`, a trailing `Icon(Icons.keyboard_arrow_up)` is added to
/// the sub-header.
///
/// Defaults to `true`.
final bool automaticallyImplyTrailing;

/// Widget to be shown as leading element to the sub-header. If set, the value
/// of [automaticallyImplyLeading] is ignored.
/// Widget to be shown as leading element to the sub-header.
///
/// If set, the value of [automaticallyImplyLeading] is ignored.
final Widget? leading;

/// Widget to be shown as trailing element to the sub-header. If set, the value
/// of [automaticallyImplyTrailing] is ignored.
/// Widget to be shown as trailing element to the sub-header.
///
/// If set, the value of [automaticallyImplyTrailing] is ignored.
final Widget? trailing;

/// Creates a [BackdropSubHeader] instance.
Expand Down

0 comments on commit 4ab4db7

Please sign in to comment.