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

docs: proper(short) first sentence of doc-comments #110

Merged
merged 2 commits into from
Dec 19, 2021
Merged

docs: proper(short) first sentence of doc-comments #110

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a979d5
docs: proper(short) first sentence of doc-comments
daadu Dec 19, 2021
9f6122c
minor improvment
daadu Dec 19, 2021
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
17 changes: 9 additions & 8 deletions lib/src/sub_header.dart
View file
Open in desktop
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