summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMikkel Fahnøe Jørgensen <mikkel@dvide.com>2016-03-26 09:22:56 +0100
committerMikkel Fahnøe Jørgensen <mikkel@dvide.com>2016-03-26 09:22:56 +0100
commit9b8c91c90b2a2e63bf6e3d96ce996dc2f7d883cd (patch)
treeeacf6edc365f7261242e0955a89ddf0c50fa1478 /docs
parent47d4b46950d92cf5056094f8f25a0a26d0ba3865 (diff)
downloadflatbuffers-9b8c91c90b2a2e63bf6e3d96ce996dc2f7d883cd.tar.gz
flatbuffers-9b8c91c90b2a2e63bf6e3d96ce996dc2f7d883cd.tar.bz2
flatbuffers-9b8c91c90b2a2e63bf6e3d96ce996dc2f7d883cd.zip
Add C support in README, minor updates in other C doc
Diffstat (limited to 'docs')
-rw-r--r--docs/source/CUsage.md11
-rw-r--r--docs/source/Tutorial.md2
2 files changed, 8 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);