BigfootDev/flatbuffers
1
0
Fork 1
mirror of https://github.com/google/flatbuffers.git synced 2026-06-19 13:43:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Various documentation clarifications.

Browse Source 
Change-Id: Ibc2bd88a636f3b4abf82a7c2722fc1e354dab848
Tested: on Linux.
This commit is contained in:
Wouter van Oortmerssen
2014-12-08 16:47:00 -08:00
parent 285501f7be
commit 2d9b3ade18
10 changed files with 52 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/source/FlatBuffers.md
View File

@@ -1,7 +1,7 @@
# FlatBuffers
FlatBuffers is an efficient cross platform serialization library for C++,
with support for Java and Go. It was created at Google specifically for game
with support for Java, C# and Go. It was created at Google specifically for game
development and other performance-critical applications.
It is available as open source under the Apache license, v2 (see LICENSE.txt).
@@ -48,8 +48,8 @@ It is available as open source under the Apache license, v2 (see LICENSE.txt).
Java and Go code supports object-reuse.
- **Cross platform C++11/Java/Go code with no dependencies** - will work with
any recent gcc/clang and VS2010. Comes with build files for the tests &
- **Cross platform C++11/Java/C#/Go code with no dependencies** - will work
with any recent gcc/clang and VS2010. Comes with build files for the tests &
samples (Android .mk files, and cmake for all other platforms).
### Why not use Protocol Buffers, or .. ?
@@ -87,10 +87,10 @@ sections provide a more in-depth usage guide.
Fields are optional and have defaults, so they don't need to be
present for every object instance.
- Use `flatc` (the FlatBuffer compiler) to generate a C++ header (or Java/Go
classes) with helper classes to access and construct serialized data. This
header (say `mydata_generated.h`) only depends on `flatbuffers.h`, which
defines the core functionality.
- Use `flatc` (the FlatBuffer compiler) to generate a C++ header (or
Java/C#/Go classes) with helper classes to access and construct serialized
data. This header (say `mydata_generated.h`) only depends on
`flatbuffers.h`, which defines the core functionality.
- Use the `FlatBufferBuilder` class to construct a flat binary buffer.
The generated functions allow you to add objects to this
@@ -110,7 +110,7 @@ sections provide a more in-depth usage guide.
- How to [write a schema](md__schemas.html).
- How to [use the generated C++ code](md__cpp_usage.html) in your own
programs.
- How to [use the generated Java code](md__java_usage.html) in your own
- How to [use the generated Java/C# code](md__java_usage.html) in your own
programs.
- How to [use the generated Go code](md__go_usage.html) in your own
programs.