tree: 53efb78ef76283cc9686b5eadbfdeceae41e78e1 [path history] [tgz]
  1. tests/
  2. BUILD.gn
  3. docsgen_transforms.py
  4. gen_helpdocs.py
  5. gen_syscalls_toc.py
  6. OWNERS
  7. README.md
tools/docsgen/README.md

Docsgen

The present tool generates reference documentation without the usage of recipes. Currently the following generation is supported.

  • Clidoc
  • CMLdoc
  • Dart
  • Driversdoc
  • FIDL
  • Helpdoc
  • Syscalls

Usage

Docsgen can be built using the command fx build tools/docsgen

For example, you can set it to a minimal configuration:

fx set minimal.x64 --with //tools/docsgen

Then, build docsgen:

fx build tools/docsgen

You can then see the built documentation in the out/default/obj/tools/docsgen directory of your Fuchsia checkout.