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 [2014/12/07 07:53] – admindoc: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 Javadoc-like source documentation tool for SWI Prolog. Structured comments in the source code are translated into HTML or LaTEX. The first line of the comment needs to start with two %% percent signs, followed by the predicate including its mode declarations as described in the PLDOC documentation. The following lines describe the predicate and its parameters.+[[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.
  
-  %% comp_temporallySubsumes(?Long, ?Short) is nondet. +To generate a webpage for KnowRob, a //rosprolog// script can be used:
-  % +
-  % Check if the time segment Long contains the segment or time point Short. +
-  % +
-  % @param Long Identifier of the longer time segment +
-  % @param Short Identifier of the contained time segment or time point +
-  %  +
-    comp_temporallySubsumes(Long, Short) :- +
-    [...]+
  
-For showing the documentation, you can run  +<code> 
-  doc_server(8080). +rosrun rosprolog rosprolog-doc knowrob 
-in Prolog, which starts the documentation server locally so that you can access it from your browser. Note that the doc server only parses those files correctly that are loaded after the server has been started.+</code>
  
-For saving the documentation locally, you can use the doc_save predicate: +This will scan through your ROS workspace for a package named "knowrob", and then generate a webpage based on the source code comments. 
-  use_module(library(doc_files)). +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]].
-  doc_save( '/work/knowrob/trunk/', [css(copy),recursive(true),doc_root('/work/knowrob/doc')]).+
  
-===== 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>