Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mutagene committed Nov 25, 2023
1 parent d78420d commit e128682
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/cli-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ djinni \
| `--cppcli-namespace ...` | The namespace name to use for generated C++/CLI classes. |
| `--cppcli-include-cpp-prefix <prefix>` | The prefix for `#include` of the main C++ header files from C++/CLI files. |

### WebAssembly/TS/JS
### WebAssembly/Typescript/Javascript

| Argument | Description |
|----------------------------------------|----------------------------------------------------------------------------|
Expand All @@ -155,6 +155,7 @@ djinni \
| `--wasm-base-lib-include-prefix` | The path prefix to be added to djinni support library inlcude lines in generated files |
| `--ts-out <out-folder>` | Path to the Typescript type definitions output folder |
| `--ts-module <module>` | Name of the module for the Typescript types. `module.ts` by default. |
| `--ts-support-files-out <out-folder>` | Path for where the support files `DjinniModule.[js|ts]` should be generated. No support files are generated if the path is not specified. |


### Yaml Generation
Expand Down Expand Up @@ -241,6 +242,15 @@ Possible values: `FooBar`, `fooBar`, `foo_bar`, `FOO_BAR`, `m_fooBar`.
| `--ident-cppcli-const` | `FooBar` |
| `--ident-cppcli-file` | `FooBar` |

#### Javascript / Typescript

| Argument | Default |
|----------------------|-----------|
| `--ident-js-enum` | `FOO_BAR` |
| `--ident-js-field` | `fooBar` |
| `--ident-js-type` | `FooBar` |


Example:

The djinni idl for an enum
Expand Down

0 comments on commit e128682

Please sign in to comment.