• Home
Name
Date
Size
#Lines
LOC

..--

gRPC/12-May-2024-3017

Benchmarks.mdD12-May-20244.8 KiB6453

Building.mdD12-May-20246.2 KiB135106

CONTRIBUTING.mdD12-May-20242.2 KiB4337

CUsage.mdD12-May-20248.1 KiB225176

Compiler.mdD12-May-20248.4 KiB223144

CppUsage.mdD12-May-202428.6 KiB639491

CsharpUsage.mdD12-May-20248.9 KiB227170

DartUsage.mdD12-May-20245 KiB10983

FlatBuffers.mdD12-May-20249.4 KiB189158

FlexBuffers.mdD12-May-20248.2 KiB205162

GoApi.mdD12-May-20241.2 KiB2721

GoApi_generated.txtD12-May-20244.5 KiB12697

GoUsage.mdD12-May-20243.7 KiB10070

Grammar.mdD12-May-20242.2 KiB7542

Internals.mdD12-May-202420.2 KiB469360

JavaScriptUsage.mdD12-May-20243.4 KiB9467

JavaUsage.mdD12-May-20244.7 KiB11588

KotlinUsage.mdD12-May-20243.7 KiB8457

LobsterUsage.mdD12-May-20243.3 KiB8660

LuaUsage.mdD12-May-20243 KiB8257

PHPUsage.mdD12-May-20243.3 KiB9067

PythonUsage.mdD12-May-20243.9 KiB10173

README_TO_GENERATE_DOCS.mdD12-May-20241.1 KiB3321

RustUsage.mdD12-May-20247.7 KiB175130

Schemas.mdD12-May-202427.8 KiB647497

Support.mdD12-May-20243.9 KiB5850

SwiftUsage.mdD12-May-20244.2 KiB9567

Tutorial.mdD12-May-2024108.1 KiB3,4463,160

TypeScriptUsage.mdD12-May-20243.5 KiB9767

WhitePaper.mdD12-May-20245.6 KiB12998

doxyfileD12-May-2024100.1 KiB2,3741,851

doxygen_layout.xmlD12-May-20248.6 KiB253228

groupsD12-May-2024675 2416

style.cssD12-May-20245.4 KiB397324

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