Differences
This shows you the differences between two versions of the page.
| |
blog:auto-generated_api_documentation [2015/02/12 20:44] – created admin | blog:auto-generated_api_documentation [2015/02/12 20:44] (current) – admin |
---|
====== Auto-generated API documentation ====== | ====== Auto-generated API documentation ====== |
| |
As part of a recent effort to update the KnowRob documentation, we have included [[/api|auto-generated API documentation]] into the KnowRob wiki and increased the documentation coverage to all exported predicates of all modules in the core KnowRob stack and several packages in knowrob_addons and knowrob_dev. | As part of a recent effort to update the KnowRob documentation, we have included [[http://knowrob.org/api|auto-generated API documentation]] into the KnowRob wiki and increased the documentation coverage to all exported predicates of all modules in the core KnowRob stack and several packages in knowrob_addons and knowrob_dev. |
| |
The documentation is generated automatically from structured comments in the source code using the [[http://www.swi-prolog.org/pldoc/package/pldoc.html|pldoc]] system, similar to the well-known javadoc or doxygen systems. It is re-generated at every commit by our Jenkins server. | The documentation is generated automatically from structured comments in the source code using the [[http://www.swi-prolog.org/pldoc/package/pldoc.html|pldoc]] system, similar to the well-known javadoc or doxygen systems. It is re-generated at every commit by our Jenkins server. |