diff options
author | Wouter van Oortmerssen <wvo@google.com> | 2014-09-26 16:46:30 -0700 |
---|---|---|
committer | Wouter van Oortmerssen <wvo@google.com> | 2014-10-15 17:42:31 -0700 |
commit | d38b9af243d8dcfc53ab69c79e0ce404759240d4 (patch) | |
tree | 9c2f4252155e404b0ade8a8780235eff9de31d18 /docs | |
parent | 18cf19f87629b54e961e2b81542aaca5bf956ada (diff) | |
download | flatbuffers-d38b9af243d8dcfc53ab69c79e0ce404759240d4.tar.gz |
Added .proto parsing and convertion to .fbs.
Bug: 15777858
Change-Id: Iabef9b8c8044e593bb89510feebdee00d2f1840b
Tested: on Linux and Windows.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/html/md__compiler.html | 9 | ||||
-rwxr-xr-x | docs/source/Compiler.md | 20 |
2 files changed, 22 insertions, 7 deletions
diff --git a/docs/html/md__compiler.html b/docs/html/md__compiler.html index cf7a0c8d..77515fe7 100644 --- a/docs/html/md__compiler.html +++ b/docs/html/md__compiler.html @@ -61,13 +61,16 @@ $(document).ready(function(){initNavTree('md__compiler.html','');}); <ul> <li><code>-c</code> : Generate a C++ header for all definitions in this file (as <code>filename_generated.h</code>). Skipped for data.</li> <li><code>-j</code> : Generate Java classes. Skipped for data.</li> +<li><code>-n</code> : Generate C# classes. Skipped for data.</li> +<li><code>-g</code> : Generate Go classes. Skipped for data.</li> <li><code>-b</code> : If data is contained in this file, generate a <code>filename.bin</code> containing the binary flatbuffer.</li> <li><code>-t</code> : If data is contained in this file, generate a <code>filename.json</code> representing the data in the flatbuffer.</li> <li><code>-o PATH</code> : Output all generated files to PATH (either absolute, or relative to the current directory). If omitted, PATH will be the current directory. PATH should end in your systems path separator, e.g. <code>/</code> or <code>\</code>.</li> <li><code>-I PATH</code> : when encountering <code>include</code> statements, attempt to load the files from this path. Paths will be tried in the order given, and if all fail (or none are specified) it will try to load relative to the path of the schema file being parsed.</li> -<li><code>-S</code> : Generate strict JSON (field names are enclosed in quotes). By default, no quotes are generated.</li> -<li><code>-P</code> : Don't prefix enum values in generated C++ by their enum type.</li> -<li><code>-H</code> : Generate include statements for included schemas the generated file depends on (C++). </li> +<li><code>--strict-json</code> : Generate strict JSON (field names are enclosed in quotes). By default, no quotes are generated.</li> +<li><code>--no-prefix</code> : Don't prefix enum values in generated C++ by their enum type.</li> +<li><code>--gen-includes</code> : Generate include statements for included schemas the generated file depends on (C++).</li> +<li><code>--proto</code>: Expect input files to be .proto files (protocol buffers). Output the corresponding .fbs file. Currently supports: <code>package</code>, <code>message</code>, <code>enum</code>. Does not support, but will skip without error: <code>import</code>, <code>option</code>. Does not support, will generate error: <code>service</code>, <code>extend</code>, <code>extensions</code>, <code>oneof</code>, <code>group</code>, custom options, nested declarations. </li> </ul> </div></div><!-- contents --> </div><!-- doc-content --> diff --git a/docs/source/Compiler.md b/docs/source/Compiler.md index 3f7675ae..2a07858b 100755 --- a/docs/source/Compiler.md +++ b/docs/source/Compiler.md @@ -21,6 +21,10 @@ be generated for each file processed: - `-j` : Generate Java classes. Skipped for data. +- `-n` : Generate C# classes. Skipped for data. + +- `-g` : Generate Go classes. Skipped for data. + - `-b` : If data is contained in this file, generate a `filename.bin` containing the binary flatbuffer. @@ -37,10 +41,18 @@ be generated for each file processed: fail (or none are specified) it will try to load relative to the path of the schema file being parsed. -- `-S` : Generate strict JSON (field names are enclosed in quotes). +- `--strict-json` : Generate strict JSON (field names are enclosed in quotes). By default, no quotes are generated. -- `-P` : Don't prefix enum values in generated C++ by their enum type. +- `--no-prefix` : Don't prefix enum values in generated C++ by their enum + type. + +- `--gen-includes` : Generate include statements for included schemas the + generated file depends on (C++). -- `-H` : Generate include statements for included schemas the generated file - depends on (C++). +- `--proto`: Expect input files to be .proto files (protocol buffers). + Output the corresponding .fbs file. + Currently supports: `package`, `message`, `enum`. + Does not support, but will skip without error: `import`, `option`. + Does not support, will generate error: `service`, `extend`, `extensions`, + `oneof`, `group`, custom options, nested declarations. |