Skip to content

Commit cf2e416

Browse files
committed
Add DartDoc categories to various classes
1 parent 89b86be commit cf2e416

17 files changed

+43
-1
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## 1.14.1
2+
3+
### Dart API
4+
5+
* Add DartDoc categories to various classes to help organize the documentation.
6+
17
## 1.14.0
28

39
### BREAKING CHANGE

lib/src/importer.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ export 'importer/result.dart';
2424
/// [AsyncImporter] if possible.
2525
///
2626
/// Subclasses should extend [Importer], not implement it.
27+
///
28+
/// {@category Importers}
2729
abstract class Importer extends AsyncImporter {
2830
/// An importer that never imports any stylesheets.
2931
///

lib/src/importer/async.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ import 'result.dart';
1919
/// instead.
2020
///
2121
/// Subclasses should extend [AsyncImporter], not implement it.
22+
///
23+
/// {@category Importers}
2224
abstract class AsyncImporter {
2325
/// If [url] is recognized by this importer, returns its canonical format.
2426
///

lib/src/importer/filesystem.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ import 'result.dart';
1111
import 'utils.dart';
1212

1313
/// An importer that loads files from a load path on the filesystem.
14+
///
15+
/// {@category Importers}
1416
class FilesystemImporter extends Importer {
1517
/// The path relative to which this importer looks for files.
1618
final String _loadPath;

lib/src/importer/package.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ import 'result.dart';
1414
final _filesystemImporter = new FilesystemImporter('.');
1515

1616
/// An importer that loads stylesheets from `package:` imports.
17+
///
18+
/// {@category Importers}
1719
class PackageImporter extends Importer {
1820
/// The resolver that converts `package:` imports to `file:`.
1921
final SyncPackageResolver _packageResolver;

lib/src/importer/result.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ import '../importer.dart';
88
import '../syntax.dart';
99

1010
/// The result of importing a Sass stylesheet, as returned by [Importer.load].
11+
///
12+
/// {@category Importers}
1113
class ImporterResult {
1214
/// The contents of the stylesheet.
1315
final String contents;

lib/src/value/external/argument_list.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ import 'value.dart';
1111
/// An argument list comes from a rest argument. It's distinct from a normal
1212
/// [SassList] in that it may contain a keyword map as well as the positional
1313
/// arguments.
14+
///
15+
/// {@category Values}
1416
abstract class SassArgumentList extends SassList {
1517
/// The keyword arguments attached to this argument list.
1618
///

lib/src/value/external/boolean.dart

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,18 @@ import '../../value.dart' as internal;
66
import 'value.dart';
77

88
/// The SassScript `true` value.
9+
///
10+
/// {@category Values}
911
SassBoolean get sassTrue => internal.sassTrue;
1012

1113
/// The SassScript `false` value.
14+
///
15+
/// {@category Values}
1216
SassBoolean get sassFalse => internal.sassFalse;
1317

1418
/// A SassScript boolean value.
19+
///
20+
/// {@category Values}
1521
abstract class SassBoolean extends Value {
1622
/// Whether this value is `true` or `false`.
1723
bool get value;

lib/src/value/external/color.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ import '../../value.dart' as internal;
66
import 'value.dart';
77

88
/// A SassScript color.
9+
///
10+
/// {@category Values}
911
abstract class SassColor extends Value {
1012
/// This color's red channel, between `0` and `255`.
1113
int get red;

lib/src/value/external/function.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ import 'value.dart';
1010
///
1111
/// A function reference captures a function from the local environment so that
1212
/// it may be passed between modules.
13+
///
14+
/// {@category Values}
1315
abstract class SassFunction extends Value {
1416
/// The callable that this function invokes.
1517
///

lib/src/value/external/list.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ import '../../value.dart' show ListSeparator;
77
import 'value.dart';
88

99
/// A SassScript list.
10+
///
11+
/// {@category Values}
1012
abstract class SassList extends Value {
1113
ListSeparator get separator;
1214

lib/src/value/external/map.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ import '../../value.dart' as internal;
66
import 'value.dart';
77

88
/// A SassScript map.
9+
///
10+
/// {@category Values}
911
abstract class SassMap extends Value {
1012
// TODO(nweiz): Use persistent data structures rather than copying here. We
1113
// need to preserve the order, which can be done by tracking an RRB vector of

lib/src/value/external/number.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ import 'value.dart';
1111
/// support scientific-style numerator and denominator units (for example,
1212
/// `miles/hour`). These are expected to be resolved before being emitted to
1313
/// CSS.
14+
///
15+
/// {@category Values}
1416
abstract class SassNumber extends Value {
1517
/// The number of distinct digits that are emitted when converting a number to
1618
/// CSS.

lib/src/value/external/string.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ import 'value.dart';
99
///
1010
/// Strings can either be quoted or unquoted. Unquoted strings are usually CSS
1111
/// identifiers, but they may contain any text.
12+
///
13+
/// {@category Values}
1214
abstract class SassString extends Value {
1315
/// The contents of the string.
1416
///

lib/src/value/external/value.dart

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ export 'number.dart';
2121
export 'string.dart';
2222

2323
/// The SassScript `null` value.
24+
///
25+
/// {@category Values}
2426
Value get sassNull => internal.sassNull;
2527

2628
// TODO(nweiz): Just mark members as @internal when sdk#28066 is fixed.
@@ -35,6 +37,8 @@ Value get sassNull => internal.sassNull;
3537
/// subclass constructors like [new SassString]. Untyped values can be cast to
3638
/// particular types using `assert*()` functions like [assertString], which
3739
/// throw user-friendly error messages if they fail.
40+
///
41+
/// {@category Values}
3842
abstract class Value {
3943
/// Whether the value counts as `true` in an `@if` statement and other
4044
/// contexts.

lib/src/value/list.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ class SassList extends Value implements ext.SassList {
5555
}
5656

5757
/// An enum of list separator types.
58+
///
59+
/// {@category Values}
5860
class ListSeparator {
5961
/// A space-separated list.
6062
static const space = const ListSeparator._("space", " ");

pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: sass
2-
version: 1.14.0
2+
version: 1.14.1
33
description: A Sass implementation in Dart.
44
author: Dart Team <[email protected]>
55
homepage: https://github.com/sass/dart-sass

0 commit comments

Comments
 (0)