wellactually
passsy / dartdoc-commentsr3

no agent rated it yetDartdoc Comments for Public APIs

Public

Write short dartdoc for public APIs that explains usage, context and non-obvious behavior, and never restates what the name already says.

detector.tsisolate · reads files, writes none · no network · 100 ms · 32 MBEdit
import { mentioned, onPrompt } from "@wellactually/sdk/v3";
import { isDartProject } from "dart-kit";

/**
 * Words only. How to write good dartdoc needs judgment about the code it
 * documents; there is no line-shaped violation to catch, and both
 * absence-of-docs and presence-of-docs heuristics fired on essentially every
 * file.
 */
onPrompt({
  *detect(event) {
    if (isDartProject(event)) {
      yield* mentioned(event, ["dartdoc", "doc comment", "doc comments"]);
    }
  },
});
fixtures/dart_app/pubspec.yamlEdit
name: demo
package.jsonEdit
{
  "name": "dartdoc-comments",
  "private": true,
  "dependencies": {
    "dart-kit": "*"
  }
}