Name |
Date |
Size |
#Lines |
LOC |
||
|---|---|---|---|---|---|---|
| .. | - | - | ||||
| gRPC/ | 22-Nov-2023 | - | 30 | 17 | ||
| Benchmarks.md | D | 22-Nov-2023 | 4.8 KiB | 64 | 53 | |
| Building.md | D | 23-Nov-2023 | 4.6 KiB | 101 | 81 | |
| CONTRIBUTING.md | D | 22-Nov-2023 | 2.2 KiB | 43 | 37 | |
| CUsage.md | D | 22-Nov-2023 | 8.1 KiB | 225 | 176 | |
| Compiler.md | D | 23-Nov-2023 | 7.4 KiB | 198 | 126 | |
| CppUsage.md | D | 23-Nov-2023 | 23.6 KiB | 557 | 415 | |
| DartUsage.md | D | 23-Nov-2023 | 5 KiB | 109 | 83 | |
| FlatBuffers.md | D | 23-Nov-2023 | 8.9 KiB | 179 | 148 | |
| FlexBuffers.md | D | 22-Nov-2023 | 6.9 KiB | 167 | 130 | |
| GoApi.md | D | 22-Nov-2023 | 1.2 KiB | 27 | 21 | |
| GoApi_generated.txt | D | 22-Nov-2023 | 4.5 KiB | 126 | 97 | |
| GoUsage.md | D | 22-Nov-2023 | 3.7 KiB | 100 | 70 | |
| Grammar.md | D | 23-Nov-2023 | 2.2 KiB | 75 | 42 | |
| Internals.md | D | 23-Nov-2023 | 19.3 KiB | 450 | 345 | |
| JavaCsharpUsage.md | D | 22-Nov-2023 | 6.9 KiB | 173 | 132 | |
| JavaScriptUsage.md | D | 22-Nov-2023 | 4 KiB | 106 | 75 | |
| LobsterUsage.md | D | 23-Nov-2023 | 3.3 KiB | 86 | 60 | |
| LuaUsage.md | D | 23-Nov-2023 | 3 KiB | 82 | 57 | |
| PHPUsage.md | D | 22-Nov-2023 | 3.3 KiB | 90 | 67 | |
| PythonUsage.md | D | 22-Nov-2023 | 3.9 KiB | 101 | 73 | |
| README_TO_GENERATE_DOCS.md | D | 22-Nov-2023 | 1.1 KiB | 33 | 21 | |
| RustUsage.md | D | 23-Nov-2023 | 7.6 KiB | 174 | 129 | |
| Schemas.md | D | 23-Nov-2023 | 25.8 KiB | 604 | 464 | |
| Support.md | D | 23-Nov-2023 | 3.3 KiB | 47 | 39 | |
| Tutorial.md | D | 23-Nov-2023 | 95.9 KiB | 3,002 | 2,743 | |
| TypeScriptUsage.md | D | 23-Nov-2023 | 2.4 KiB | 67 | 45 | |
| WhitePaper.md | D | 22-Nov-2023 | 5.6 KiB | 129 | 98 | |
| doxyfile | D | 23-Nov-2023 | 100.1 KiB | 2,372 | 1,849 | |
| doxygen_layout.xml | D | 23-Nov-2023 | 8.4 KiB | 249 | 224 | |
| groups | D | 23-Nov-2023 | 675 | 24 | 16 | |
| style.css | D | 22-Nov-2023 | 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