Skip to content

Commit 9320ff0

Browse files
committed
doc: add categories
1 parent fc69fe5 commit 9320ff0

80 files changed

Lines changed: 331 additions & 29 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@ pubspec.lock
1010
.fvm/
1111
custom_lint.log
1212
grumpy_lints.log
13-
build/
13+
build/
14+
doc/
15+
pubspec_overrides.yaml

dartdoc_options.yaml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
dartdoc:
2+
categories:
3+
module:
4+
displayName: Modules
5+
markdown: lib/src/module/README.md
6+
routing:
7+
displayName: Routing
8+
markdown: lib/src/routing/README.md
9+
repo:
10+
displayName: Repositories
11+
markdown: lib/src/repo/README.md
12+
cache:
13+
displayName: Caching
14+
markdown: lib/src/cache/README.md
15+
persistence:
16+
displayName: Persistence
17+
markdown: lib/src/persistence/README.md
18+
transactions:
19+
displayName: Transactions
20+
markdown: lib/src/transactions/README.md
21+
telemetry:
22+
displayName: Telemetry & Analytics
23+
markdown: lib/src/telemetry/README.md
24+
presentation:
25+
displayName: Presentation Layer
26+
markdown: lib/src/presentation/README.md
27+
shared:
28+
displayName: Shared Primitives
29+
markdown: lib/src/shared/README.md
30+
categoryOrder: [Shared Primitives, Modules,Presentation Layer, Repositories, Routing, Caching, Persistence, Transactions, Telemetry & Analytics]
31+
showUndocumentedCategories: true

lib/src/cache/domain/models/cache_entry.dart

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
import 'package:grumpy/grumpy.dart';
22

33
/// Stored cache entry with optional expiry metadata.
4+
///
5+
/// {@category cache}
6+
47
class CacheEntry<T> extends Model {
58
/// Creates a cache entry.
69
const CacheEntry({

lib/src/cache/domain/models/cache_policy.dart

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ import 'package:grumpy/grumpy.dart';
1212
/// `CachePolicy(useMemory: true, useFile: true, fileTtl: ...)`
1313
/// - Strict debugging mode:
1414
/// `CachePolicy(strictLayerErrors: true)`
15+
///
16+
/// {@category cache}
17+
1518
class CachePolicy<Serialized extends Object> extends Model {
1619
/// Creates cache behavior options for a query read/write cycle.
1720
const CachePolicy({

lib/src/cache/domain/models/cache_result.dart

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
import 'package:grumpy/grumpy.dart';
22

33
/// Source used to satisfy a cache lookup.
4+
///
5+
/// {@category cache}
6+
47
enum CacheSource {
58
/// Value came from the memory layer.
69
memory,
@@ -13,6 +16,9 @@ enum CacheSource {
1316
}
1417

1518
/// Returned cache value with source metadata.
19+
///
20+
/// {@category cache}
21+
1622
class CacheResult<T> extends Model {
1723
/// Creates a cache lookup result.
1824
const CacheResult({

lib/src/cache/domain/services/cache_layer_service.dart

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ import 'dart:typed_data';
33
import 'package:grumpy/grumpy.dart';
44

55
/// Shared cache layer surface.
6+
///
7+
/// {@category cache}
8+
69
abstract class CacheLayerService extends Service {
710
/// Returns the DI-registered implementation of [CacheLayerService].
811
///

lib/src/cache/domain/services/cache_pipeline_service.dart

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ import 'package:grumpy/grumpy.dart';
1010
///
1111
/// Repos typically do not call this service directly. Prefer [QueryMixin],
1212
/// which integrates this pipeline automatically when registered.
13+
///
14+
/// {@category cache}
15+
1316
abstract class CachePipelineService extends Service {
1417
/// Returns the DI-registered cache pipeline.
1518
factory CachePipelineService() => Service.get<CachePipelineService>();

lib/src/cache/domain/services/file_cache_layer_service.dart

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
import 'package:grumpy/grumpy.dart';
22

33
/// L2 persistent cache layer.
4+
///
5+
/// {@category cache}
6+
47
abstract class FileCacheLayerService extends CacheLayerService {
58
/// Returns the DI-registered implementation of [FileCacheLayerService].
69
///

lib/src/cache/domain/services/memory_cache_layer_service.dart

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
import 'package:grumpy/grumpy.dart';
22

33
/// L1 in-memory cache layer.
4+
///
5+
/// {@category cache}
6+
47
abstract class MemoryCacheLayerService extends CacheLayerService {
58
/// Returns the DI-registered implementation of [MemoryCacheLayerService].
69
///

lib/src/cache/infra/services/default_cache_pipeline_service.dart

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ import 'package:grumpy/grumpy.dart';
1212
/// - write-through to enabled layers when policy allows
1313
/// - per-layer TTL application
1414
/// - optional strict error propagation
15+
///
16+
/// {@category cache}
17+
1518
class DefaultCachePipelineService extends CachePipelineService {
1619
/// Creates a default pipeline with optional memory/file layers.
1720
DefaultCachePipelineService({

0 commit comments

Comments
 (0)