fantomas icon indicating copy to clipboard operation
fantomas copied to clipboard

Published 20 hours ago • verified publisher icon fsprojects

API documentation

Open nojaf opened this issue 2 years ago • 0 comments

Currently, the default setting of FsDoc generates API documentation. We should be a bit more selective about which modules/namespaces make sense to have.

  • Fantomas.FCS: only expose the Parser API and SyntaxTree (+ trivia)
  • Fantomas.Core: CodeFormatter is the public API. Some internal APIs might also be relevant, TriviaTypes for example
  • Fantomas.Client: Is used by editors, and should also be exposed.

Please also identify pages where the documentation is poor. We should add more XML documentation comments where necessary.

nojaf avatar Jul 01 '22 09:07 nojaf