From 9b8c91c90b2a2e63bf6e3d96ce996dc2f7d883cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mikkel=20Fahn=C3=B8e=20J=C3=B8rgensen?= <mikkel@dvide.com> Date: Sat, 26 Mar 2016 09:22:56 +0100 Subject: [PATCH] Add C support in README, minor updates in other C doc --- docs/source/CUsage.md | 11 +++++++---- docs/source/Tutorial.md | 2 +- readme.md | 1 + 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/source/CUsage.md b/docs/source/CUsage.md index 0c87ce95..9397e04d 100644 --- a/docs/source/CUsage.md +++ b/docs/source/CUsage.md @@ -15,8 +15,8 @@ project. - [Tutorial](@ref flatbuffers_guide_tutorial) - select C as language when scrolling down -- General Use in C (the README) <https://github.com/dvidelabs/flatcc/blob/master/README.md> -- The C Builder Interface, advanced <https://github.com/dvidelabs/flatcc/blob/master/doc/builder.md> +- General Use in C (README) <https://github.com/dvidelabs/flatcc/blob/master/README.md> +- The C Builder Interface (advanced) <https://github.com/dvidelabs/flatcc/blob/master/doc/builder.md> ## Basic Reflection @@ -25,7 +25,7 @@ The C-API does support reading binary schema (.bfbs) files via code generated from the `reflection.fbs` schema, and an [example usage](https://github.com/dvidelabs/flatcc/tree/master/samples/reflection) shows how to use this. The schema files are pre-generated -in the [runtime distribution](https://github.com/dvidelabs/flatcc/tree/master/include/flatcc/reflection). Extended reflection +in the [runtime distribution](https://github.com/dvidelabs/flatcc/tree/master/include/flatcc/reflection). ## Mutating Reflection @@ -37,9 +37,12 @@ buffers using complex objects from existing buffers as source. This can be very efficient due to direct copy semantics without endian conversion or temporary stack allocation. +Scalars, structs and strings can be used as source, as well vectors of +these. + It is currently not possible to use an existing table or vector of table as source, but it would be possible to add support for this at some -point. +point. Vectors of strings ## Why not integrate with the `flatc` tool? diff --git a/docs/source/Tutorial.md b/docs/source/Tutorial.md index dfcc3ad7..4547a219 100644 --- a/docs/source/Tutorial.md +++ b/docs/source/Tutorial.md @@ -1293,7 +1293,7 @@ like so: // The returned buffer must be deallocated using `free`. // NOTE: Finalizing the buffer does NOT change the builder, it // just creates a snapshot of the builder content. - buf = flatcc_builder_finalize_buffer(&builder, &size); + buf = flatcc_builder_finalize_buffer(B, &size); // use buf free(buf); diff --git a/readme.md b/readme.md index 95460486..15dd41b1 100755 --- a/readme.md +++ b/readme.md @@ -15,6 +15,7 @@ unpacking/parsing it first, while still having great forwards/backwards compatib ## Supported programming languages * C++ * C# +* C * Go * Java * JavaScript -- GitLab