BigfootDev/flatbuffers
1
0
Fork 1
mirror of https://github.com/google/flatbuffers.git synced 2026-07-01 07:11:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Compiler.md docs (#8153)

Browse Source 
* Escape singel underscores in markdown

* Update language generator flags in docs

* Complet the list of Python options
This commit is contained in:
Felix
2023-11-18 21:08:04 +01:00
committed by GitHub
parent 46577d0d2f
commit eb64390080
1 changed files with 23 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/source/Compiler.md
View File

@@ -23,31 +23,35 @@ For any schema input files, one or more generators can be specified:
- `--java`, `-j` : Generate Java code. - `--java`, `-j` : Generate Java code.
- `--kotlin`, `-k` : Generate Kotlin code. - `--kotlin` , `--kotlin-kmp` : Generate Kotlin code.
- `--csharp`, `-n` : Generate C# code. - `--csharp`, `-n` : Generate C# code.
- `--go`, `-g` : Generate Go code. - `--go`, `-g` : Generate Go code.
- `--python`, `-p`: Generate Python code. - `--python`, `-p` : Generate Python code.
- `--js`, `-s`: Generate JavaScript code. - `--js`, `-s` : Generate JavaScript code.
- `--ts`: Generate TypeScript code. - `--ts`, `-T` : Generate TypeScript code.
- `--php`: Generate PHP code. - `--php` : Generate PHP code.
- `--grpc`: Generate RPC stub code for GRPC. - `--grpc` : Generate RPC stub code for GRPC.
- `--dart`: Generate Dart code. - `--dart`, `-d` : Generate Dart code.
- `--lua`: Generate Lua code. - `--lua`, `-l` : Generate Lua code.
- `--lobster`: Generate Lobster code. - `--lobster` : Generate Lobster code.
- `--rust`, `-r` : Generate Rust code. - `--rust`, `-r` : Generate Rust code.
- `--swift`: Generate Swift code. - `--swift` : Generate Swift code.
- `--nim` : Generate Nim code.
For any data input files: For any data input files:
@@ -58,6 +62,8 @@ For any data input files:
- `--json`, `-t` : If data is contained in this file, generate a - `--json`, `-t` : If data is contained in this file, generate a
`filename.json` representing the data in the flatbuffer. `filename.json` representing the data in the flatbuffer.
- `--jsonschema` : Generate Json schema
Additional options: Additional options:
- `-o PATH` : Output all generated files to PATH (either absolute, or - `-o PATH` : Output all generated files to PATH (either absolute, or
@@ -115,7 +121,7 @@ Additional options:
- `--gen-compare` : Generate operator== for object-based API types. - `--gen-compare` : Generate operator== for object-based API types.
- `--gen-nullable` : Add Clang _Nullable for C++ pointer. or @Nullable for Java. - `--gen-nullable` : Add Clang \_Nullable for C++ pointer. or @Nullable for Java.
- `--gen-generated` : Add @Generated annotation for Java. - `--gen-generated` : Add @Generated annotation for Java.
@@ -189,7 +195,7 @@ Additional options:
`--conform PATH`. `--conform PATH`.
- `--filename-suffix SUFFIX` : The suffix appended to the generated - `--filename-suffix SUFFIX` : The suffix appended to the generated
file names. Default is '_generated'. file names. Default is '\_generated'.
- `--filename-ext EXTENSION` : The extension appended to the generated - `--filename-ext EXTENSION` : The extension appended to the generated
file names. Default is language-specific (e.g. "h" for C++). This file names. Default is language-specific (e.g. "h" for C++). This
@@ -227,5 +233,10 @@ Additional options:
vector of bytes in JSON, which is unsafe unless checked by a verifier vector of bytes in JSON, which is unsafe unless checked by a verifier
afterwards. afterwards.
- `--python-no-type-prefix-suffix` : Skip emission of Python functions that are prefixed
with typenames
- `--python-typing` : Generate Python type annotations
NOTE: short-form options for generators are deprecated, use the long form NOTE: short-form options for generators are deprecated, use the long form
whenever possible. whenever possible.