From 2a979d57c2e176bb5256019643205f1b5a059a88 Mon Sep 17 00:00:00 2001 From: Harsh Bhikadia Date: Sun, 19 Dec 2021 17:51:00 +0530 Subject: [PATCH 1/2] docs: proper(short) first sentence of doc-comments --- lib/src/sub_header.dart | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/lib/src/sub_header.dart b/lib/src/sub_header.dart index 9c98b6c..6f28ab8 100644 --- a/lib/src/sub_header.dart +++ b/lib/src/sub_header.dart @@ -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"). @@ -31,8 +32,7 @@ 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 for adding default leading widget. /// /// If set to `true`, a leading `Icon(Icons.keyboard_arrow_up)` is added to /// the sub-header. @@ -40,8 +40,7 @@ class BackdropSubHeader extends StatelessWidget { /// Defaults to `false`. final bool automaticallyImplyLeading; - /// Flag indicating whether the trailing widget for the sub-header should be - /// automatically determined by [BackdropSubHeader]. + /// Flag for adding default trailing widget. /// /// If set to `true`, a trailing `Icon(Icons.keyboard_arrow_up)` is added to /// the sub-header. @@ -49,12 +48,14 @@ class BackdropSubHeader extends StatelessWidget { /// 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. From 9f6122cf84a90fdaa255f2c21d45e87c64950c0c Mon Sep 17 00:00:00 2001 From: Harsh Bhikadia Date: Sun, 19 Dec 2021 17:52:33 +0530 Subject: [PATCH 2/2] minor improvment --- lib/src/sub_header.dart | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/src/sub_header.dart b/lib/src/sub_header.dart index 6f28ab8..7ececce 100644 --- a/lib/src/sub_header.dart +++ b/lib/src/sub_header.dart @@ -32,7 +32,7 @@ class BackdropSubHeader extends StatelessWidget { /// Defaults to `EdgeInsets.symmetric(vertical: 12.0, horizontal: 16.0)`. final EdgeInsets padding; - /// Flag for adding default leading widget. + /// 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. @@ -40,7 +40,7 @@ class BackdropSubHeader extends StatelessWidget { /// Defaults to `false`. final bool automaticallyImplyLeading; - /// Flag for adding default trailing widget. + /// 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.