This is an old revision of the document!


Source code documentation with PLDOC

PLDOC is a source documentation framework for SWI Prolog. Structured comments in the source code can be translated into HTML or LaTex. Please consult the official documentation about the concrete format supported.

To generate a webpage for KnowRob, a rosprolog script can be used:

rosrun rosprolog rosprolog-doc knowrob

This will scan through your ROS workspace for a package named “knowrob”, and then generate a webpage based on the source code comments. This API documentation webpage is continuously deployed via a hook in GitHub. The most up to date API documentation can be found here.

Generate documentation for KnowRob packages

The rosprolog-doc script starts Prolog and generates the documentation in the doc subfolder. You can call it using the following command:

rosrun rosprolog rosprolog-doc <pkgname>