-
Notifications
You must be signed in to change notification settings - Fork 12
Concurrents and similar projects
You will find here a list of projects similar to aadarchi, that is to say allowing the automatic generation of documentation of a project, in particular by integrating diagrams.
Doxygen https://www.doxygen.nl/
Doxygen is a tool for generating documentation from source code. It is aimed at C++, but it can also be used with PHP, Java, Python, etc. It can create online HTML documentation. It can also be used to generate output in multiple formats, including Unix man pages, PostScript, etc.
The biggest advantage of using Doxygen is that you will have consistency throughout your source code documentation. It can also help you to generate code structure using the undocumented source files.
- Output example : https://www.doxygen.nl/manual/examples/qtstyle/html/class_q_tstyle___test.html
- Diagram output : https://www.doxygen.nl/manual/examples/diagrams/html/annotated.html
Doxygen is a free software, released under the terms of the GNU General Public License
Interactive HTML based output
Works best with C++, so diagrams generation seem to only work with this language
##Swimm https://swimm.io/
Swimm allows developers to create Markdown documentation with templates and auto-suggestions, and then find them right beside their code, inline, visible in the IDE and Github. Docs being coupled to the code means Swimm can auto-update examples in your docs whenever the relevant code implementation changes. It references documentation right within VSCode and in the documentation you can quote the code, which is automatically updated if any changes are committed to the repository.
3 different prices :
- Free : with one private repo, 5 users and 30 verification tests per month
- Standard (8$/month) : Unlimited repos, 75 users, 100 tests
- Pro (20$/month): Unlimited users, automatic auto-sync approval, unlimited tests
- Link : https://swimm.io/pricing/
Unlike most other tools, Swimm can generate documentation without the need to conform to certain code structures or conventions or a need for adding inline code comments.
Explains the code point by point, not very precise diagrams. 13 points ? Architecture model unclear, available only from the IDE.
##Codex?