Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in / Register
Toggle navigation
F
flatbuffers
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Packages
Packages
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
submodule
flatbuffers
Commits
7d396bc2
Commit
7d396bc2
authored
Apr 07, 2016
by
Mikkel Fahnøe Jørgensen
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update C documentation with supported MSVC versions, and other minor updates.
parent
1db9783b
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
40 additions
and
32 deletions
+40
-32
CUsage.md
docs/source/CUsage.md
+17
-8
FlatBuffers.md
docs/source/FlatBuffers.md
+3
-3
Support.md
docs/source/Support.md
+17
-17
Tutorial.md
docs/source/Tutorial.md
+3
-4
No files found.
docs/source/CUsage.md
View file @
7d396bc2
...
...
@@ -10,22 +10,31 @@ JSON parsers, printers.
Great care has been taken to ensure compatibily with the main
`flatc`
project.
## General Documention
-
[
Tutorial
](
@ref
flatbuffers_guide_tutorial) - select C as language
when scrolling down
-
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>
-
[
FlatCC Guide
](
https://github.com/dvidelabs/flatcc#flatcc-flatbuffers-in-c-for-c
)
-
[
The C Builder Interface
](
https://github.com/dvidelabs/flatcc/blob/master/doc/builder.md#the-builder-interface
)
-
[
The Monster Sample in C
](
https://github.com/dvidelabs/flatcc/blob/master/samples/monster/monster.c
)
-
[
GitHub
](
https://github.com/dvidelabs/flatcc
)
## Supported Platforms
-
Ubuntu
-
OS-X
-
Windows
-
Ubuntu (clang / gcc, ninja / gnu make)
-
OS-X (clang / gcc, ninja / gnu make)
-
Windows MSVC 2010, 2013, 2015
CI builds recent versions of gcc, clang and MSVC on OS-X, Ubuntu, and
Windows, and occasionally older compiler versions. See main project
[
Status
](
https://github.com/dvidelabs/flatcc#status
)
.
Other platforms may well work, including Centos, but are not tested
regularly.
Centos has been tested at some point and ARM cross compilation has been reported to
work to some extend, but these are not regularly tested.
The monster sample project was specifically written for C99 in order to
follow the C++ version and for that reason it will not work with MSVC
2010.
## Modular Object Creation
...
...
docs/source/FlatBuffers.md
View file @
7d396bc2
...
...
@@ -4,9 +4,9 @@ FlatBuffers {#flatbuffers_index}
# Overview {#flatbuffers_overview}
[
FlatBuffers
](
@ref
flatbuffers_overview) is an efficient cross platform
serialization library for C++, C#, C, Go, Java, JavaScript, PHP, and Python
(Ruby and Swift in progress). It was originally created at Google for game
development and other
performance-critical applications.
serialization library for C++, C#, C, Go, Java, JavaScript, PHP, and Python
.
It was originally created at Google for game development and other
performance-critical applications.
It is available as Open Source on
[
GitHub
](
http://github.com/google/flatbuffers
)
under the Apache license, v2 (see LICENSE.txt).
...
...
docs/source/Support.md
View file @
7d396bc2
...
...
@@ -18,23 +18,23 @@ In general:
NOTE: this table is a start, it needs to be extended.
Feature | C++ | Java | C# | Go | Python | JS | C | PHP | Ruby
------------------------------ | ------ | ------ | ------ | ------ | ------ | --------- | ---- | --- | ----
Codegen for all basic features | Yes | Yes | Yes | Yes | Yes | Yes | Yes | WiP | WiP
JSON parsing | Yes | No | No | No | No | No | Yes | No | No
Simple mutation | Yes | WIP | WIP | No | No | No | No | No | No
Reflection | Yes | No | No | No | No | No | Basic| No | No
Buffer verifier | Yes | No | No | No | No | No | Yes | No | No
Testing: basic | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ? | ?
Testing: fuzz | Yes | No | No | Yes | Yes | No | No | ? | ?
Performance: | Superb | Great | Great | Great | Ok | ? |
Superb
| ? | ?
Platform: Windows | VS2010 | Yes | Yes | ? | ? | ? |
Yes
| ? | ?
Platform: Linux | GCC282 | Yes | ? | Yes | Yes | ? | Yes | ? | ?
Platform: OS X | Xcode4 | ? | ? | ? | Yes | ? | Yes | ? | ?
Platform: Android | NDK10d | Yes | ? | ? | ? | ? | ? | ? | ?
Platform: iOS | ? | ? | ? | ? | ? | ? | ? | ? | ?
Engine: Unity | ? | ? | Yes | ? | ? | ? | ? | ? | ?
Primary authors (github) | gwvo | gwvo | ev
*/js*
| rw | rw | evanw/ev
* | mik*
| ch
*
| rw
Feature | C++ | Java | C# | Go | Python | JS | C
| PHP | Ruby
------------------------------ | ------ | ------ | ------ | ------ | ------ | --------- | ----
--
| --- | ----
Codegen for all basic features | Yes | Yes | Yes | Yes | Yes | Yes | Yes
| WiP | WiP
JSON parsing | Yes | No | No | No | No | No | Yes
| No | No
Simple mutation | Yes | WIP | WIP | No | No | No | No
| No | No
Reflection | Yes | No | No | No | No | No | Basic
| No | No
Buffer verifier | Yes | No | No | No | No | No | Yes
| No | No
Testing: basic | Yes | Yes | Yes | Yes | Yes | Yes | Yes
| ? | ?
Testing: fuzz | Yes | No | No | Yes | Yes | No | No
| ? | ?
Performance: | Superb | Great | Great | Great | Ok | ? |
Superb
| ? | ?
Platform: Windows | VS2010 | Yes | Yes | ? | ? | ? |
VS2010
| ? | ?
Platform: Linux | GCC282 | Yes | ? | Yes | Yes | ? | Yes
| ? | ?
Platform: OS X | Xcode4 | ? | ? | ? | Yes | ? | Yes
| ? | ?
Platform: Android | NDK10d | Yes | ? | ? | ? | ? | ?
| ? | ?
Platform: iOS | ? | ? | ? | ? | ? | ? | ?
| ? | ?
Engine: Unity | ? | ? | Yes | ? | ? | ? | ?
| ? | ?
Primary authors (github) | gwvo | gwvo | ev
*/js*
| rw | rw | evanw/ev
* | mik*
| ch
*
| rw
*
ev = evolutional
*
js = jonsimantov
...
...
docs/source/Tutorial.md
View file @
7d396bc2
...
...
@@ -19,17 +19,16 @@ character, the hero of the story, needs to slay some `orc`s. We will walk
through each step necessary to create this monster type using FlatBuffers.
Please select your desired language for our quest:
\h
tmlonly
<form>
<input
type=
"radio"
name=
"language"
value=
"cpp"
checked=
"checked"
>
C++
</input>
<input
type=
"radio"
name=
"language"
value=
"java"
>
Java
</input>
<input
type=
"radio"
name=
"language"
value=
"csharp"
>
C#
</input>
<input
type=
"radio"
name=
"language"
value=
"c"
>
C
</input>
<input
type=
"radio"
name=
"language"
value=
"go"
>
Go
</input>
<input
type=
"radio"
name=
"language"
value=
"
java"
>
Java
</input>
<input
type=
"radio"
name=
"language"
value=
"
python"
>
Python
</input>
<input
type=
"radio"
name=
"language"
value=
"javascript"
>
JavaScript
</input>
<input
type=
"radio"
name=
"language"
value=
"php"
>
PHP
</input>
<input
type=
"radio"
name=
"language"
value=
"
python"
>
Python
</input>
<input
type=
"radio"
name=
"language"
value=
"
c"
>
C
</input>
</form>
\e
ndhtmlonly
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment