Archives: Automatic Code Documentation Generation

Does the auto generated documentation get erased with each new pull request?

No. It does not get erased. SoftaCheck maintains previous versions of the documentation for your reference. For each new pull request, the documentation is regenerated and given a unique link address that is different than the previous versions.

How does the automatic code documentation generation work?

SoftaCheck uses an open-source tool called Doxygen. It runs it automatically on your code. When SoftaCheck analysis is done, you can check your pull request page and a link shall appear under the SoftaCheck check page. The link will take you to the documentation of your code that has been generated using Doxygen. Only people…