feat(dynamite): add doc comments someOf extensions

Signed-off-by: Nikolas Rimikis <[email protected]>
nextcloud · Dec 29, 2023 · 23646f3 · 23646f3
1 parent c4600a3
commit 23646f3
Showing 1 changed file with 15 additions and 9 deletions.
diff --git a/packages/dynamite/dynamite/lib/src/builder/generate_ofs.dart b/packages/dynamite/dynamite/lib/src/builder/generate_ofs.dart
@@ -1,5 +1,6 @@
 import 'package:code_builder/code_builder.dart';
 import 'package:dynamite/src/builder/state.dart';
+import 'package:dynamite/src/helpers/built_value.dart';
 import 'package:dynamite/src/helpers/dart_helpers.dart';
 import 'package:dynamite/src/models/openapi.dart' as openapi;
 import 'package:dynamite/src/models/type_result.dart';
@@ -16,18 +17,15 @@ Iterable<Spec> buildOfsExtensions(
       continue;
     }
 
-    final serializerMethod = Method(
-      (final b) => b
-        ..static = true
-        ..returns = refer('Serializer<${result.className}>')
-        ..type = MethodType.getter
-        ..name = 'serializer'
-        ..lambda = true
-        ..body = Code('${result.typeName}Extension._serializer'),
-    );
+    final serializerMethod = buildSerializer(result.className, '${result.typeName}Extension._serializer');
 
     final toJson = Method(
       (final b) => b
+        ..docs.addAll([
+          '/// Creates a new object from the given [json] data.',
+          '///',
+          '/// Use `toJson` to serialize it back into json.',
+        ])
         ..static = true
         ..returns = refer(result.className)
         ..name = 'fromJson'
@@ -44,6 +42,7 @@ Iterable<Spec> buildOfsExtensions(
 
     yield Extension(
       (final b) => b
+        ..docs.add('/// @nodoc')
         ..name = '\$${result.className}Extension'
         ..on = refer(result.className)
         ..methods.addAll([
@@ -93,6 +92,7 @@ Iterable<Spec> generateSomeOf(
 
   final oneOfValidator = Method((final b) {
     b
+      ..docs.add('/// {@macro Dynamite.validateOneOf}')
       ..name = 'validateOneOf'
       ..returns = refer('void')
       ..lambda = true
@@ -101,6 +101,7 @@ Iterable<Spec> generateSomeOf(
 
   final anyOfValidator = Method((final b) {
     b
+      ..docs.add('/// {@macro Dynamite.validateAnyOf}')
       ..name = 'validateAnyOf'
       ..returns = refer('void')
       ..lambda = true
@@ -135,6 +136,11 @@ Iterable<Spec> generateSomeOf(
 
   final toJson = Method(
     (final b) => b
+      ..docs.addAll([
+        '/// Parses this object into a json like map.',
+        '///',
+        '/// Use the fromJson factory to revive it again.',
+      ])
       ..name = 'toJson'
       ..returns = refer('Object?')
       ..lambda = true