Parser tools for generating CCS Java documentation
Project description
CCS command documentation helper
List the available commands information such as the name, the level, the type and the description.
Usage
parse
Use the command-line tool ccsdoc
to list the commands either on a given file or in a directory.
- on a single file
ccsdoc parse --path JavaFile.java
- on a full directory to process recursively all .java files
ccsdoc parse --path java_project_dir
Commands can be output to a CSV file.
ccsdoc parse --path JavaFile.java --to javafile_commands.csv
convert
The CSV table containing the commands can be converted to the desired format using pandoc
# e.g. here to Microsoft Word
ccsdoc convert javafile_commands.csv --to docx
Examples
Working example
$ ccsdoc parse --path SimuEPOSController.java
SimuEPOSController.java:
Command(name=setPosition, type=ACTION, level=ENGINEERING1, desc=For simulator only : Update position with a position given as argument.)
Command(name=checkFault, type=QUERY, level=ENGINEERING1, desc=Check if the Controller is in fault.)
Missing argument example
$ ccsdoc parse --path SimuLoaderStandalonePlutoGateway.java
SimuLoaderStandalonePlutoGateway.java:
=> simulation/SimuLoaderStandalonePlutoGateway.java: issue at line 39: Missing command argument 'description'.
Installation
pip install git+https://github.com/aboucaud/command-doc-generator.git
Author
Alexandre Boucaud aboucaud@apc.in2p3.fr
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ccsdoc-0.0.8.tar.gz
(14.5 kB
view hashes)
Built Distribution
ccsdoc-0.0.8-py2.py3-none-any.whl
(11.2 kB
view hashes)
Close
Hashes for ccsdoc-0.0.8-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9de06c2ca8ab018a7d20449677092f3ec0486bd9380b7ac58d17c72e8fbfc3db |
|
MD5 | b2c233654c4fc0be7e176663a1977d9a |
|
BLAKE2b-256 | 232650036f8dbf685d7102a62428dc968b1d2df384c93acd1542fcb978a8461d |