Toolchain used for automatically developing documentation for your library.
The documentation generator's initial goal is to support documentation of the following component information:
- Name
- Static Methods
- Static Properties
- Constructor
- Lifecycle Methods
- Custom Methods
- Custom Properties
- Render Method
It looks to document each method available on the component class using a combination of support for both JSDoc and flow syntax.
For a file to be consider part of the doc generator, have the following @-pragma:
/**
* Copyright (c) 2015 IBM Corp.
* All Rights Reserved.
*
* @doc [option]
*/[option] defaults to a General section in the generated doc site.
Usage:
docgen src docs
The goal of this project is to ultimately create a living styleguide that will host instances of each component that will render next to the documentation and will be editable by users viewing the document site.
Another goal at an application level is to integrate routing into the generated documentation. If a set routing structure is determined, it will be useful to see the entry points into an application and the data requirements at every point established by graphql queries.
Future @-pragma possibility: @doc [engine] [section/subsection], where the engine could be react or just jsdoc, etc.
- Deploy to GHE Pages
- Find way to colocate tests, hook into a CI build to see if passing (webhooks?)