Name |
Date |
Size |
#Lines |
LOC |
||
|---|---|---|---|---|---|---|
| .. | - | - | ||||
| Benchmarks.md | D | 22-Nov-2023 | 4.8 KiB | 64 | 53 | |
| Building.md | D | 22-Nov-2023 | 2.9 KiB | 68 | 52 | |
| CONTRIBUTING.md | D | 01-Jan-1970 | 0 | |||
| CUsage.md | D | 22-Nov-2023 | 8.1 KiB | 225 | 176 | |
| Compiler.md | D | 22-Nov-2023 | 4.9 KiB | 128 | 87 | |
| CppUsage.md | D | 22-Nov-2023 | 17.4 KiB | 406 | 304 | |
| FlatBuffers.md | D | 22-Nov-2023 | 8.3 KiB | 169 | 138 | |
| FlexBuffers.md | D | 22-Nov-2023 | 6.6 KiB | 157 | 125 | |
| 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 | 22-Nov-2023 | 1.4 KiB | 49 | 28 | |
| Internals.md | D | 22-Nov-2023 | 18.9 KiB | 440 | 339 | |
| JavaCsharpUsage.md | D | 22-Nov-2023 | 6.9 KiB | 172 | 131 | |
| JavaScriptUsage.md | D | 22-Nov-2023 | 4 KiB | 106 | 75 | |
| PHPUsage.md | D | 22-Nov-2023 | 3.3 KiB | 90 | 67 | |
| PythonUsage.md | D | 22-Nov-2023 | 2.8 KiB | 74 | 52 | |
| README_TO_GENERATE_DOCS.md | D | 22-Nov-2023 | 1.1 KiB | 33 | 21 | |
| Schemas.md | D | 22-Nov-2023 | 23 KiB | 546 | 415 | |
| Support.md | D | 22-Nov-2023 | 2.7 KiB | 45 | 37 | |
| Tutorial.md | D | 22-Nov-2023 | 64.3 KiB | 1,944 | 1,745 | |
| WhitePaper.md | D | 22-Nov-2023 | 5.6 KiB | 129 | 98 | |
| doxyfile | D | 22-Nov-2023 | 99.9 KiB | 2,365 | 1,842 | |
| doxygen_layout.xml | D | 22-Nov-2023 | 7.8 KiB | 235 | 210 | |
| groups | D | 22-Nov-2023 | 576 | 21 | 14 | |
| 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