ANN: DocInsight Insiders CLI (Version 6.0.0.23)

DocInsight
1

Hi,

We are holding the next update (Build 23) for the upcoming Delphi release (under NDA). We have posted it on the beta forum of Embarcadero, please try it if you can visit it.

Currently, we extracted the CLI docinsight.exe to get early feedback if possible. It contains:

  • Resolve cref in the project group
  • Add --allow cref_unresolved to docinsight build/check to suppress cref unresolved warnings

[Download CLI]
File size: 14.52 MB
Sha-256: 299fc1fa9823e3c6aeb011ebad3a15f5b2c738e086f3075fdddbff1ecef8ec7c

Download the file and override docinsight.exe in the installation folder (typically %LOCALAPPDATA%\Programs\DevJet\DocInsight-Insiders\6.0\bin)

1 Like
2

Note: The arg --allow lint is hidden option for now (Not shown when you run the command with -h). We plan to support more diagnostics related to documentation in future updates. e.g.

  • Xml documentation syntax error
  • Cannot parse cref (Syntax error)
  • Cannot resolve cref
  • Cannot resolve overload in cref
  • Param name xx not found
  • Doc comment above ident list
  • Missing documentation for public element
  • Link to private element
  • File path too long
  • and much more…
1 Like