Name |
Date |
Size |
#Lines |
LOC |
||
---|---|---|---|---|---|---|
.. | - | - | ||||
gRPC/ | 12-May-2024 | - | 30 | 17 | ||
Benchmarks.md | D | 12-May-2024 | 4.8 KiB | 64 | 53 | |
Building.md | D | 12-May-2024 | 6.2 KiB | 135 | 106 | |
CONTRIBUTING.md | D | 12-May-2024 | 2.2 KiB | 43 | 37 | |
CUsage.md | D | 12-May-2024 | 8.1 KiB | 225 | 176 | |
Compiler.md | D | 12-May-2024 | 8.4 KiB | 223 | 144 | |
CppUsage.md | D | 12-May-2024 | 28.6 KiB | 639 | 491 | |
CsharpUsage.md | D | 12-May-2024 | 8.9 KiB | 227 | 170 | |
DartUsage.md | D | 12-May-2024 | 5 KiB | 109 | 83 | |
FlatBuffers.md | D | 12-May-2024 | 9.4 KiB | 189 | 158 | |
FlexBuffers.md | D | 12-May-2024 | 8.2 KiB | 205 | 162 | |
GoApi.md | D | 12-May-2024 | 1.2 KiB | 27 | 21 | |
GoApi_generated.txt | D | 12-May-2024 | 4.5 KiB | 126 | 97 | |
GoUsage.md | D | 12-May-2024 | 3.7 KiB | 100 | 70 | |
Grammar.md | D | 12-May-2024 | 2.2 KiB | 75 | 42 | |
Internals.md | D | 12-May-2024 | 20.2 KiB | 469 | 360 | |
JavaScriptUsage.md | D | 12-May-2024 | 3.4 KiB | 94 | 67 | |
JavaUsage.md | D | 12-May-2024 | 4.7 KiB | 115 | 88 | |
KotlinUsage.md | D | 12-May-2024 | 3.7 KiB | 84 | 57 | |
LobsterUsage.md | D | 12-May-2024 | 3.3 KiB | 86 | 60 | |
LuaUsage.md | D | 12-May-2024 | 3 KiB | 82 | 57 | |
PHPUsage.md | D | 12-May-2024 | 3.3 KiB | 90 | 67 | |
PythonUsage.md | D | 12-May-2024 | 3.9 KiB | 101 | 73 | |
README_TO_GENERATE_DOCS.md | D | 12-May-2024 | 1.1 KiB | 33 | 21 | |
RustUsage.md | D | 12-May-2024 | 7.7 KiB | 175 | 130 | |
Schemas.md | D | 12-May-2024 | 27.8 KiB | 647 | 497 | |
Support.md | D | 12-May-2024 | 3.9 KiB | 58 | 50 | |
SwiftUsage.md | D | 12-May-2024 | 4.2 KiB | 95 | 67 | |
Tutorial.md | D | 12-May-2024 | 108.1 KiB | 3,446 | 3,160 | |
TypeScriptUsage.md | D | 12-May-2024 | 3.5 KiB | 97 | 67 | |
WhitePaper.md | D | 12-May-2024 | 5.6 KiB | 129 | 98 | |
doxyfile | D | 12-May-2024 | 100.1 KiB | 2,374 | 1,851 | |
doxygen_layout.xml | D | 12-May-2024 | 8.6 KiB | 253 | 228 | |
groups | D | 12-May-2024 | 675 | 24 | 16 | |
style.css | D | 12-May-2024 | 5.4 KiB | 397 | 324 |
README_TO_GENERATE_DOCS.md
1## Prerequisites 2 3To generate the docs for FlatBuffers from the source files, you 4will first need to install two programs. 5 61. You will need to install `doxygen`. See 7 [Download Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html). 8 92. You will need to install `doxypypy` to format python comments appropriately. 10 Install it from [here](https://github.com/Feneric/doxypypy). 11 12*Note: You will need both `doxygen` and `doxypypy` to be in your 13[PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable.* 14 15After you have both of those files installed and in your path, you need to 16set up the `py_filter` to invoke `doxypypy` from `doxygen`. 17 18Follow the steps 19[here](https://github.com/Feneric/doxypypy#invoking-doxypypy-from-doxygen). 20 21## Generating Docs 22 23Run the following commands to generate the docs: 24 25`cd flatbuffers/docs/source` 26`doxygen` 27 28The output is placed in `flatbuffers/docs/html`. 29 30*Note: The Go API Reference code must be generated ahead of time. For 31instructions on how to regenerated this file, please read the comments 32in `GoApi.md`.* 33