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 with access to your repository will have access to the documentation and this is enforced by checking your GitHub credentials upon accessing the documentation. If you have cookies enabled in your browser, you won’t be asked to enter your credentials again after the first time you did so.