ccsdoc 0.0.7

Parser tools for generating CCS Java documentation

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 [e-mail]