added clarifications on the swagger generator

pr
Override-6 2 years ago
parent 83cee3ee0b
commit 26d27fc7c2

@ -19,6 +19,9 @@ This command generates the documentation and deploys it on your CodeDoc space
- `-t --type [docusaurus|doxygen|swagger]` type of documentation generator to use. - **required** - `-t --type [docusaurus|doxygen|swagger]` type of documentation generator to use. - **required**
- `-d --dest [dir]` path to where to put the documentation outputs in your repository's CodeDoc space - **optional <u>!! cannot be absolute !!</u>** - `-d --dest [dir]` path to where to put the documentation outputs in your repository's CodeDoc space - **optional <u>!! cannot be absolute !!</u>**
Note !
For swagger, you have to pass the configuration file instead of a directory
usage examples : usage examples :
``` ```

Loading…
Cancel
Save