Find Undocumented (public)
Uses query find to list indexed symbols filtered by documentation state, kind, or visibility.
Read this when you want to know which public symbols still lack a DocInsight comment. query find with --no-docs and --public lists them; --doc-tag and --doc-contains filter by comment content instead. Also under drag-lint > Code Quality in the IDE.
How to run it
Full flag list: query in the CLI reference.
Flags
| Flag | Argument | Meaning | Default |
|---|---|---|---|
--doc-tag | X | ||
--doc-contains | Y | ||
--decl-contains | Z | ||
--no-docs | |||
--kind | K | ||
--name | N | ||
--unit | U | ||
--public | |||
--db |
Where to click
- RAD Studio main menu: drag-lint > Code Quality > Find Undocumented (public)...
Pitfalls
- --no-docs is a FILTER (UNDOCUMENTED symbols only), not "hide the docs" -- to list them all use query --kind
<k>--all - --decl-contains searches the DECLARING SOURCE LINE (
stored X,default V,read F write S) -- clauses the index does not model. Needs --kind, --name or --unit; it re-reads source per candidate. - case-insensitive, over /// blocks and harvested // above a declaration.
- declaration clauses the index does not model.
query --textsees string literals and comment prose, not declaring lines -- this reads the declaring line instead.
Details
Uses query find to list indexed symbols filtered by documentation state,
kind, or visibility. Reach for it to see which public symbols still have no
DocInsight comment.
Running it from the CLI
drag-lint query find [--doc-tag X | --doc-contains Y | --no-docs] [--kind K] [--public] [--db ...]--no-docs restricts results to symbols with no doc comment; --public
restricts to public symbols; --doc-tag/--doc-contains filter by tag or
tag content instead of by absence; --kind filters by symbol kind.
--doc-tag accepts exactly nine tags: summary, remarks, returns,
param, exception, example, seealso, since, deprecated. An
unrecognized tag errors (exit 2) and lists the valid set.
Reaching it in the IDE
drag-lint > Code Quality > Find Undocumented (public)...
What it needs
The --db flag is optional -- drag-lint auto-resolves the project's index
when omitted. An index must still exist.
Example
Illustrative only:
drag-lint query find --no-docs --public --db C:\Projects\MyApp\_D-RAG\MyApp.sqliteThis would list MyApp's public symbols that carry no doc comment.