applyDescription method

String applyDescription(String schema, Element declaration, { String? sourceComment, })

Adds an explicit Ack description or a tagged documentation description.

Analyzer does not attach parameter doc comments to parameter elements. A function generator passes the comment from its source AST.

Implementation

String applyDescription(
  String schema,
  Element declaration, {
  String? sourceComment,
}) {
  final String? tag;
  try {
    tag = parseDescriptionTag(
      sourceComment ?? declaration.documentationComment,
    );
  } on FormatException catch (error) {
    throw InvalidGenerationSource(
      '${declaration.name} ${error.message}',
      element: declaration,
    );
  }
  final annotation = _ackField.firstAnnotationOfExact(declaration);
  final value = annotation == null
      ? null
      : ConstantReader(annotation).read('description');
  final explicit = value == null || value.isNull ? null : value.stringValue;
  if (explicit != null && explicit.trim().isEmpty) {
    throw InvalidGenerationSource(
      '${declaration.name} @AckField.description must not be blank.',
      element: declaration,
    );
  }
  final description = explicit ?? tag;
  return description == null
      ? schema
      : '$schema.describe(${dartStringLiteral(description)})';
}