The file src/openvas.c contains the following lines, which probably serve to generate possible Doxygen documentation:
/**
* @mainpage
*
* @section Introduction
* @verbinclude README.md
*
* @section license License Information
* @verbinclude COPYING
*/
But the @verbinclude command includes the contents of the file README.md verbatim in the documentation and inhibits so the rendering of the contained markdown as can be seen here:
https://fossies.org/dox/openvas-scanner-23.39.4/
(or using a version independent URL: https://fossies.org/dox/openvas-scanner/)
If this is not the desired behavior, the command should be replaced with
@include{doc} (or the old fashioned @includedoc).
Incidentally, the server fossies.org now also generates codespell reports, including for the openvas-scanner project:
https://fossies.org/linux/misc/openvas/openvas-scanner/codespell.html
and
https://fossies.org/linux/misc/openvas/openvas-scanner/codespell.full.html
(including also "Changes"-related files and "test" like directories).
But good news: No severe errors were found.
The file
src/openvas.ccontains the following lines, which probably serve to generate possible Doxygen documentation:But the
@verbincludecommand includes the contents of the fileREADME.mdverbatim in the documentation and inhibits so the rendering of the contained markdown as can be seen here:https://fossies.org/dox/openvas-scanner-23.39.4/
(or using a version independent URL: https://fossies.org/dox/openvas-scanner/)
If this is not the desired behavior, the command should be replaced with
@include{doc}(or the old fashioned@includedoc).Incidentally, the server fossies.org now also generates
codespellreports, including for theopenvas-scannerproject:https://fossies.org/linux/misc/openvas/openvas-scanner/codespell.html
and
https://fossies.org/linux/misc/openvas/openvas-scanner/codespell.full.html
(including also "Changes"-related files and "test" like directories).
But good news: No severe errors were found.