Permalink
Browse files

Revamping the FlatBuffers docs.

Adding an API reference for the supported languages.

General docs cleanup, including a new `tutorial` section that
supports all of the supported languages.

Added samples for each supported language to mirror the new
tutorial page.

Cleaned up all the links by making them `@ref` style links,
instead of referencing the names of the generated `.html` files.

Removed all generated files that were unnecessarily committed.

Also fixed the C# tests (two were failing due to a missing file).

Bug: b/25801305

Tested: Tested all samples on Ubuntu, Mac, and Android. Docs were
generated using doxygen and viewed on Chrome.

Change-Id: I2acaba6e332a15ae2deff5f26a4a25da7bd2c954
  • Loading branch information...
1 parent d75d29e commit 69a31b807a85e9a5ca4efb839f37ecb6dcf3eed5 @mrhappyasthma mrhappyasthma committed Dec 4, 2015
Showing with 5,523 additions and 5,903 deletions.
  1. 0 CONTRIBUTING.md → CONTRIBUTING
  2. +0 −8 docs/documentation.html
  3. BIN docs/html/bc_s.png
  4. BIN docs/html/bdwn.png
  5. BIN docs/html/closed.png
  6. +0 −1,440 docs/html/doxygen.css
  7. BIN docs/html/doxygen.png
  8. +0 −97 docs/html/dynsections.js
  9. BIN docs/html/fpl_logo_small.png
  10. BIN docs/html/ftv2blank.png
  11. BIN docs/html/ftv2cl.png
  12. BIN docs/html/ftv2doc.png
  13. BIN docs/html/ftv2folderclosed.png
  14. BIN docs/html/ftv2folderopen.png
  15. BIN docs/html/ftv2lastnode.png
  16. BIN docs/html/ftv2link.png
  17. BIN docs/html/ftv2mlastnode.png
  18. BIN docs/html/ftv2mnode.png
  19. BIN docs/html/ftv2mo.png
  20. BIN docs/html/ftv2node.png
  21. BIN docs/html/ftv2ns.png
  22. BIN docs/html/ftv2plastnode.png
  23. BIN docs/html/ftv2pnode.png
  24. BIN docs/html/ftv2splitbar.png
  25. BIN docs/html/ftv2vertline.png
  26. +0 −149 docs/html/index.html
  27. +0 −72 docs/html/jquery.js
  28. +0 −113 docs/html/md__benchmarks.html
  29. +0 −87 docs/html/md__building.html
  30. +0 −115 docs/html/md__compiler.html
  31. +0 −192 docs/html/md__cpp_usage.html
  32. +0 −122 docs/html/md__go_usage.html
  33. +0 −96 docs/html/md__grammar.html
  34. +0 −200 docs/html/md__internals.html
  35. +0 −146 docs/html/md__java_usage.html
  36. +0 −120 docs/html/md__python_usage.html
  37. +0 −214 docs/html/md__schemas.html
  38. +0 −124 docs/html/md__support.html
  39. +0 −109 docs/html/md__white_paper.html
  40. BIN docs/html/nav_f.png
  41. BIN docs/html/nav_g.png
  42. BIN docs/html/nav_h.png
  43. +0 −143 docs/html/navtree.css
  44. +0 −552 docs/html/navtree.js
  45. +0 −17 docs/html/navtreeindex0.js
  46. BIN docs/html/open.png
  47. +0 −92 docs/html/pages.html
  48. +0 −97 docs/html/resize.js
  49. +0 −396 docs/html/style.css
  50. BIN docs/html/sync_off.png
  51. BIN docs/html/sync_on.png
  52. BIN docs/html/tab_a.png
  53. BIN docs/html/tab_b.png
  54. BIN docs/html/tab_h.png
  55. BIN docs/html/tab_s.png
  56. +0 −60 docs/html/tabs.css
  57. +15 −12 docs/source/Benchmarks.md
  58. +33 −11 docs/source/Building.md
  59. +1 −0 docs/source/CONTRIBUTING.md
  60. +2 −1 docs/source/Compiler.md
  61. +76 −200 docs/source/CppUsage.md
  62. +26 −22 docs/source/FlatBuffers.md
  63. +26 −0 docs/source/GoApi.md
  64. +125 −0 docs/source/GoApi_generated.txt
  65. +48 −94 docs/source/GoUsage.md
  66. +2 −1 docs/source/Grammar.md
  67. +11 −3 docs/source/Internals.md
  68. +141 −0 docs/source/JavaCsharpUsage.md
  69. +105 −0 docs/source/JavaScriptUsage.md
  70. +0 −224 docs/source/JavaUsage.md
  71. +89 −0 docs/source/PHPUsage.md
  72. +46 −88 docs/source/PythonUsage.md
  73. +32 −0 docs/source/README_TO_GENERATE_DOCS.md
  74. +23 −18 docs/source/Schemas.md
  75. +4 −1 docs/source/Support.md
  76. +1,723 −0 docs/source/Tutorial.md
  77. +3 −2 docs/source/WhitePaper.md
  78. +54 −54 docs/source/doxyfile
  79. +230 −0 docs/source/doxygen_layout.xml
  80. +20 −0 docs/source/groups
  81. +24 −24 docs/source/style.css
  82. +129 −26 include/flatbuffers/flatbuffers.h
  83. +8 −1 java/com/google/flatbuffers/Constants.java
  84. +284 −71 java/com/google/flatbuffers/FlatBufferBuilder.java
  85. +9 −1 java/com/google/flatbuffers/Struct.java
  86. +71 −17 java/com/google/flatbuffers/Table.java
  87. +46 −10 js/flatbuffers.js
  88. +128 −11 net/FlatBuffers/FlatBufferBuilder.cs
  89. +69 −25 php/FlatbufferBuilder.php
  90. +146 −45 python/flatbuffers/builder.py
  91. +11 −6 readme.md
  92. +137 −0 samples/SampleBinary.cs
  93. +106 −0 samples/SampleBinary.java
  94. +115 −0 samples/SampleBinary.php
  95. +48 −0 samples/android/AndroidManifest.xml
  96. +510 −0 samples/android/build_apk.sh
  97. +1 −1 samples/android/jni/Android.mk
  98. +18 −3 samples/android/jni/main.cpp
  99. +20 −0 samples/android/res/values/strings.xml
  100. +35 −0 samples/android_sample.sh
  101. +49 −0 samples/csharp_sample.sh
  102. +62 −0 samples/go_sample.sh
  103. +50 −0 samples/java_sample.sh
  104. +47 −0 samples/javascript_sample.sh
  105. +9 −2 samples/monster.fbs
  106. +0 −153 samples/monster_generated.h
  107. +2 −2 samples/monsterdata.json
  108. +47 −0 samples/php_sample.sh
  109. +47 −0 samples/python_sample.sh
  110. +49 −11 samples/sample_binary.cpp
  111. +165 −0 samples/sample_binary.go
  112. +137 −0 samples/sample_binary.py
  113. +3 −2 samples/sample_text.cpp
  114. +106 −0 samples/samplebinary.js
  115. BIN tests/FlatBuffers.Test/Resources/monsterdata_test.mon
File renamed without changes.
@@ -1,8 +0,0 @@
-<html>
-<head>
-<meta http-equiv="refresh" content="0;url=html/index.html">
-</head>
-<body>
-<a href="html/index.html">Click here if you are not redirected.</a>
-</body>
-</html>
View
Deleted file not rendered
View
Deleted file not rendered
View
Deleted file not rendered
Oops, something went wrong.

0 comments on commit 69a31b8

Please sign in to comment.