Skip to content

Commit 9643f11

Browse files
committed
fix: add @Nodoc for pages not to be documented
1 parent aaccc44 commit 9643f11

File tree

6 files changed

+15
-19
lines changed

6 files changed

+15
-19
lines changed

ouds_core/lib/components/navigation_bar/ouds_navigation_bar.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@
1010
* Software description: Flutter library of reusable graphical components for Android and iOS
1111
*/
1212

13+
/// @nodoc
1314
import 'package:flutter/material.dart';
1415
import 'package:ouds_core/components/navigation_bar/ouds_navigation_bar_item.dart';
1516

17+
///
1618
/// OUDS Navigation Bar.
1719
///
1820
/// The navigation bar displays a list of destinations that can be selected.

ouds_core/lib/components/navigation_bar/ouds_navigation_bar_item.dart

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* Software description: Flutter library of reusable graphical components for Android and iOS
1111
*/
1212

13+
/// @nodoc
1314
import 'package:flutter/material.dart';
1415
import 'package:flutter_svg/flutter_svg.dart';
1516

@@ -25,14 +26,10 @@ class OudsNavigationItem extends NavigationDestination {
2526
selectedIcon: _buildIcon(icon, badge, context, isSelected: true),
2627
);
2728

28-
static Widget _buildIcon(
29-
dynamic iconData, String? badge, BuildContext context,
30-
{bool isSelected = false}) {
29+
static Widget _buildIcon(dynamic iconData, String? badge, BuildContext context, {bool isSelected = false}) {
3130
var colorScheme = Theme.of(context).colorScheme;
3231

33-
var colorFilter = isSelected
34-
? ColorFilter.mode(colorScheme.onPrimary, BlendMode.srcIn)
35-
: ColorFilter.mode(colorScheme.primary, BlendMode.srcIn);
32+
var colorFilter = isSelected ? ColorFilter.mode(colorScheme.onPrimary, BlendMode.srcIn) : ColorFilter.mode(colorScheme.primary, BlendMode.srcIn);
3633

3734
/// If the type is IconType.icon, use the provided icon (of type Icon)
3835
Widget iconWidget = iconData is Widget
@@ -56,8 +53,7 @@ class OudsNavigationItem extends NavigationDestination {
5653
excludeSemantics: true,
5754
child: Image.asset(iconData),
5855
)
59-
: throw Exception(
60-
'Invalid icon type: ${iconData.runtimeType}')));
56+
: throw Exception('Invalid icon type: ${iconData.runtimeType}')));
6157

6258
/// If the odsBottomNavigationItemIcon.badge parameter is not empty, use the Widget Badge
6359
return badge != null

ouds_core/lib/components/navigation_rail/ouds_navigation_rail.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@
1010
* Software description: Flutter library of reusable graphical components for Android and iOS
1111
*/
1212

13+
/// @nodoc
1314
import 'package:flutter/material.dart';
1415
import 'package:ouds_core/components/navigation_rail/ouds_navigation_rail_item.dart';
1516

16-
/// ODS Navigation Rail.
17+
/// OUDS Navigation Rail.
1718
///
1819
/// The Navigation Rail is meant to be displayed at the left or right of an app to navigate between
1920
/// a small number of views, typically between three and five.
@@ -64,8 +65,7 @@ class OudsNavigationRail extends StatelessWidget {
6465
onDestinationSelected: onDestinationSelected,
6566
destinations: destinations,
6667
labelType: NavigationRailLabelType.all,
67-
leading: leadingIconFirst != null ||
68-
leadingIconSecond != null
68+
leading: leadingIconFirst != null || leadingIconSecond != null
6969
? Column(
7070
children: [
7171
if (leadingIconFirst != null) leadingIconFirst!,

ouds_core/lib/components/navigation_rail/ouds_navigation_rail_item.dart

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* Software description: Flutter library of reusable graphical components for Android and iOS
1111
*/
1212

13+
/// @nodoc
1314
import 'package:flutter/material.dart';
1415
import 'package:flutter_svg/flutter_svg.dart';
1516

@@ -29,13 +30,9 @@ class OudsNavigationRailItem extends NavigationRailDestination {
2930
selectedIcon: _buildIcon(icon, badge, context, isSelected: true),
3031
);
3132

32-
static Widget _buildIcon(
33-
dynamic iconData, String? badge, BuildContext context,
34-
{bool isSelected = false}) {
33+
static Widget _buildIcon(dynamic iconData, String? badge, BuildContext context, {bool isSelected = false}) {
3534
var colorScheme = Theme.of(context).colorScheme;
36-
var colorFilter = isSelected
37-
? ColorFilter.mode(colorScheme.onPrimary, BlendMode.srcIn)
38-
: ColorFilter.mode(colorScheme.primary, BlendMode.srcIn);
35+
var colorFilter = isSelected ? ColorFilter.mode(colorScheme.onPrimary, BlendMode.srcIn) : ColorFilter.mode(colorScheme.primary, BlendMode.srcIn);
3936

4037
/// If the type is IconType.icon, use the provided icon (of type Icon)
4138
Widget iconWidget = iconData is Widget
@@ -59,8 +56,7 @@ class OudsNavigationRailItem extends NavigationRailDestination {
5956
excludeSemantics: true,
6057
child: Image.asset(iconData),
6158
)
62-
: throw Exception(
63-
'Invalid icon type: ${iconData.runtimeType}')));
59+
: throw Exception('Invalid icon type: ${iconData.runtimeType}')));
6460

6561
/// If the odsBottomNavigationItemIcon.badge parameter is not empty, use the Widget Badge
6662
return badge != null

ouds_core/lib/modules/module-about/about_screen.dart

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* Software description: Flutter library of reusable graphical components for Android and iOS
1111
*/
1212

13+
/// @nodoc
1314
import 'package:flutter/material.dart';
1415

1516
class AboutScreen extends StatelessWidget {

ouds_core/lib/modules/module-more/more_screen.dart

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* Software description: Flutter library of reusable graphical components for Android and iOS
1111
*/
1212

13+
/// @nodoc
1314
import 'package:flutter/material.dart';
1415

1516
class MoreScreen extends StatelessWidget {

0 commit comments

Comments
 (0)