Skip to content

Commit 1c09c49

Browse files
committed
in progress
1 parent 71c9c6f commit 1c09c49

File tree

7 files changed

+26
-6
lines changed

7 files changed

+26
-6
lines changed

dartdoc_options.yaml

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
dartdoc:
2+
showStats: true
23
categories:
34
"Mixable Widgets":
45
markdown: lib/topics/mixable_widgets.md
@@ -20,8 +21,6 @@ dartdoc:
2021
- 'lib/src/dto/box_shadow.dto.dart'
2122
- 'lib/src/dto/text_style.dto.dart'
2223
- 'lib/src/dto/border_radius.dto.dart'
23-
- 'lib/src/attributes/directives/text/text_directive.utils.dart'
24-
- 'lib/src/attributes/directives/text/text_directive.attributes.dart'
2524
- 'lib/src/attributes/directives/text/text_directive_short.utils.dart'
2625
- 'lib/src/attributes/variants/variants_short.utils.dart'
2726
- 'lib/src/attributes/variants/variants.utils.dart'
@@ -92,7 +91,11 @@ dartdoc:
9291
- 'lib/src/attributes/box/box.utils.dart'
9392
- 'lib/src/widgets/text.widget.dart'
9493
- 'lib/src/attributes/text/text.attributes.dart'
95-
- 'lib/src/attributes/text/text.utils.dart'
94+
- 'lib/src/attributes/text/text.utils.dart'
95+
- 'lib/src/attributes/directives/text/text_directive.utils.dart'
96+
- 'lib/src/attributes/directives/text/text_directive.attributes.dart'
97+
98+
9699

97100

98101

lib/src/attributes/directives/text/text_directive.attributes.dart

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ enum TextModifier {
1010
}
1111

1212
/// Attribute that is able to modify text
13+
/// {@category Attributes}
14+
/// {@subCategory Directives}
1315
class TextDirectiveAttribute extends DirectiveAttribute<String> {
1416
const TextDirectiveAttribute(this.modifier);
1517

lib/src/attributes/directives/text/text_directive.utils.dart

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,39 @@
11
import 'package:mix/mix.dart';
2-
2+
///
3+
/// ## Widget
4+
/// - [TextMix](TextMix-class.html)
5+
///
6+
/// {@category Utilities}
7+
/// {@subCategory Directives}
38
class TextDirectiveUtils {
49
const TextDirectiveUtils._();
510

11+
/// Short Util: (none)
612
static TextDirectiveAttribute directive(TextModifier modifier) {
713
return TextDirectiveAttribute(modifier);
814
}
915

16+
/// Short Util: upperCase
1017
static TextDirectiveAttribute upperCase() {
1118
return directive(TextModifier.upperCase);
1219
}
1320

21+
/// Short Util: lowerCase
1422
static TextDirectiveAttribute lowerCase() {
1523
return directive(TextModifier.lowerCase);
1624
}
1725

26+
/// Short Util: capitalize
1827
static TextDirectiveAttribute capitalize() {
1928
return directive(TextModifier.capitalize);
2029
}
2130

31+
/// Short Util: sentenceCase
2232
static TextDirectiveAttribute sentenceCase() {
2333
return directive(TextModifier.sentenceCase);
2434
}
2535

36+
/// Short Util: titleCase
2637
static TextDirectiveAttribute titleCase() {
2738
return directive(TextModifier.titleCase);
2839
}

lib/src/attributes/exports.dart

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ export './box/box_short.utils.dart';
88
/// Text Directives
99
export './directives/text/text_directive.attributes.dart';
1010
export './directives/text/text_directive_short.utils.dart';
11+
export './directives/text/text_directive.utils.dart';
1112

1213
/// Flex
1314
export './flex/flex.attributes.dart';

lib/src/widgets/text.widget.dart

+2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ import 'mixable.widget.dart';
1313
///
1414
/// ## Attributes:
1515
/// - [TextAttributes](TextAttributes-class.html)
16+
/// - [TextDirectiveAttribute](TextDirectiveAttribute-class.html)
1617
/// ## Utilities:
1718
/// - [TextUtility](TextUtility-class.html)
1819
/// - [TextStyleUtility](TextStyleUtility-class.html)
20+
/// - [TextDirectiveUtils](TextDirectiveUtils-class.html)
1921
/// {@category Mixable Widgets}
2022
class TextMix extends MixableWidget {
2123
const TextMix(

lib/topics/attributes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
The _Attributes_ system in _Mix_ consists of three types of objects:
22
- _Attributes_ (these classes) &mdash; the classes that actually are instantiated in the _Mix_ object.
33
- [_Utilities_](./Utilities-topic.html) &mdash; These classes provide static functions that can instantiate their corresponding _Attribute_ classes.
4-
- [_Short Utils_](./Short%20Utils-topic.html) &mdash; One line abbreviated functions that invoke the corresponding _Utility_ class to instantiate the corresponding _Attribute_ class.
4+
- _Short Utils_ &mdash; One line abbreviated functions that invoke the corresponding _Utility_ class to instantiate the corresponding _Attribute_ class.
55

6-
This may seem like a lot of parts to create _Attributes_, but under normal circumstances, you won't deal with any of the _Attribute_ or _Utility_ classes, directly. Rather, you will instantiate them using the [_Short Utils_](./Short%20Utils-topic.html) utility functions.
6+
This may seem like a lot of parts to create _Attributes_, but under normal circumstances, you won't deal with any of the _Attribute_ or _Utility_ classes, directly. Rather, you will instantiate them using the _Short Utils_ utility functions (These are listed in their corresponding _Utility_ functions.)
77

88
_Attribute_ classes are listed here for completeness.

mkapidoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
#! /bin/sh -v
2+
rm -rf doc/api
23
dart ../dartdoc/bin/dartdoc.dart --pretty-index-json

0 commit comments

Comments
 (0)