createMarkdownDocumentation method

  1. @override
List<String> createMarkdownDocumentation(
  1. RenderContext renderContext,
  2. int titleLevel
)
inherited

Implementation

@override
List<String> createMarkdownDocumentation(
  RenderContext renderContext,
  int titleLevel,
) {
  var writer = HtmlTableWriter();
  writer.setHeader(titleLevel, '$name Function');
  if (description != null) {
    writer.addRow(['description:', description!], [1, 4]);
  }
  writer.addRow(['return type:', typeDescription<R>()], [1, 4]);
  writer.addRow(['expression example:', _createExpressionExample()], [1, 4]);
  if (exampleCode != null) {
    writer.addRow(['code example:', exampleCode!.githubMarkdownLink], [1, 4]);
  }
  var parameterRows = parameters
      .map(
        (parameter) =>
            parameter.createMarkdownDocumentation(renderContext, titleLevel),
      )
      .flattened;
  writer.rows.addAll(parameterRows);
  return writer.toHtmlLines();
}