Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
doc:pldoc_code_documentation [2014/11/28 16:17] – created admin | doc:pldoc_code_documentation [2021/02/15 14:21] (current) – daniel86 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Source code documentation | + | ====== Source code documentation ====== |
- | [[http:// | + | [[http:// |
- | %% comp_temporallySubsumes(? | + | To generate a webpage for KnowRob, a // |
- | % | + | |
- | % 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, | + | |
- | [...] | + | |
- | For showing the documentation, | + | < |
- | | + | 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. | + | </ |
- | For saving | + | This will scan through your ROS workspace for a package named " |
- | 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/ | + | |
- | ===== Generate Documentation for ROS packages ===== | ||
- | |||
- | The // | ||
- | rosrun rosprolog rosprolog-doc < | ||