FM / source

/srv/osrm/osrm-backend/third_party/flatbuffers/docs/source/

/srv/osrm/osrm-backend/third_party/flatbuffers/docs/source

Name	Size	Mode	Actions
gRPC/	-	0755	rm
Benchmarks.md	4946	0644	edit dl rm
Building.md	4708	0644	edit dl rm
Compiler.md	8001	0644	edit dl rm
CONTRIBUTING.md	2242	0644	edit dl rm
CppUsage.md	27376	0644	edit dl rm
CUsage.md	8284	0644	edit dl rm
DartUsage.md	5153	0644	edit dl rm
doxyfile	102503	0644	edit dl rm
doxygen_layout.xml	8635	0644	edit dl rm
FlatBuffers.md	9219	0644	edit dl rm
FlexBuffers.md	7041	0644	edit dl rm
GoApi.md	1206	0644	edit dl rm
GoApi_generated.txt	4615	0644	edit dl rm
GoUsage.md	3782	0644	edit dl rm
Grammar.md	2267	0644	edit dl rm
groups	675	0644	edit dl rm
Internals.md	20064	0644	edit dl rm
JavaCsharpUsage.md	7055	0644	edit dl rm
JavaScriptUsage.md	4066	0644	edit dl rm
KotlinUsage.md	3774	0644	edit dl rm
LobsterUsage.md	3383	0644	edit dl rm
LuaUsage.md	3085	0644	edit dl rm
PHPUsage.md	3360	0644	edit dl rm
PythonUsage.md	3997	0644	edit dl rm
README_TO_GENERATE_DOCS.md	1078	0644	edit dl rm
RustUsage.md	7871	0644	edit dl rm
Schemas.md	27101	0644	edit dl rm
style.css	5507	0644	edit dl rm
Support.md	3425	0644	edit dl rm
Tutorial.md	104592	0644	edit dl rm
TypeScriptUsage.md	2431	0644	edit dl rm
WhitePaper.md	5744	0644	edit dl rm

Edit: /srv/osrm/osrm-backend/third_party/flatbuffers/docs/source/README_TO_GENERATE_DOCS.md (1078B)

## Prerequisites

To generate the docs for FlatBuffers from the source files, you
will first need to install two programs.

1. You will need to install `doxygen`. See
   [Download Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html).

2. You will need to install `doxypypy` to format python comments appropriately.
   Install it from [here](https://github.com/Feneric/doxypypy).

*Note: You will need both `doxygen` and `doxypypy` to be in your
[PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable.*

After you have both of those files installed and in your path, you need to
set up the `py_filter` to invoke `doxypypy` from `doxygen`.

Follow the steps
[here](https://github.com/Feneric/doxypypy#invoking-doxypypy-from-doxygen).

## Generating Docs

Run the following commands to generate the docs:

`cd flatbuffers/docs/source`
`doxygen`

The output is placed in `flatbuffers/docs/html`.

*Note: The Go API Reference code must be generated ahead of time. For
instructions on how to regenerated this file, please read the comments
in `GoApi.md`.*

## Prerequisites To generate the docs for FlatBuffers from the source files, you will first need to install two programs. 1. You will need to install `doxygen`. See [Download Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html). 2. You will need to install `doxypypy` to format python comments appropriately. Install it from [here](https://github.com/Feneric/doxypypy). *Note: You will need both `doxygen` and `doxypypy` to be in your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable.* After you have both of those files installed and in your path, you need to set up the `py_filter` to invoke `doxypypy` from `doxygen`. Follow the steps [here](https://github.com/Feneric/doxypypy#invoking-doxypypy-from-doxygen). ## Generating Docs Run the following commands to generate the docs: `cd flatbuffers/docs/source` `doxygen` The output is placed in `flatbuffers/docs/html`. *Note: The Go API Reference code must be generated ahead of time. For instructions on how to regenerated this file, please read the comments in `GoApi.md`.*