Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
doc:pldoc_code_documentation [2021/02/15 14:20] – [Source code documentation with PLDOC] daniel86doc:pldoc_code_documentation [2021/02/15 14:21] (current) – daniel86
Line 1: Line 1:
-====== Source code documentation with PLDOC ======+====== Source code documentation ======
  
-[[http://www.swi-prolog.org/pldoc/package/pldoc.html|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.+[[http://www.swi-prolog.org/pldoc/package/pldoc.html|PLDOC]] is a source code documentation framework for SWI Prolog and used by KnowRob for the Prolog code base of KnowRob. 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: To generate a webpage for KnowRob, a //rosprolog// script can be used:
Line 12: Line 12:
 This API documentation webpage is continuously deployed via a hook in GitHub. The most up to date API documentation can be found [[https://knowrob.github.io/knowrob/master|here]]. This API documentation webpage is continuously deployed via a hook in GitHub. The most up to date API documentation can be found [[https://knowrob.github.io/knowrob/master|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>