Home
ThingDoc is a clever things comment parser.
When the hardware projects gets more and more complex it is very hard to keep documentation in a good shape and verbose at the same time. ThingDoc is here to help so you don't need to do that by hand anymore!
It uses syntax similar to Javadoc and is able to generate:
- BoM text file
- HTML documentation
- TeX documentation
- Wiki documentation (suitable for the reprap.org wiki)
- Dependency tree in text-mode and using GraphViz
- change into folder containing your things (Currently .scad and .tdoc files are supported)
- run
thingdoc - directory called docs containing the documentation is created
To modify the default behaviour, check the commandline arguments by running: thingdoc --help
ThingDoc was conceived by Josef Prusa and being developed by Pavol Rusnak. It is currently running as the documentation engine for the RepRap Prusa Mendel. See http://github.com/prusajr/PrusaMendel for more awesomeness.