DuoS/SDK_SG200x_V2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
Develop
SDK_SG200x_V2/flatbuffers/docs/source/README_TO_GENERATE_DOCS.md
carbon 93b1517102 add flatbuffers 
commit 6da1cf79d90eb242e7da5318241d42279a3df3ba
Author: Max Burke <max@urbanlogiq.com>
Date:   Sun Jan 19 14:47:28 2020 -0800

    [rust] Add use declarations to Rust-generated bindings for imported FB definitions (#5645)

    * Bugfix for Rust generation of union fields named with language keywords
2024-05-31 14:12:12 +08:00

1.1 KiB
Raw Permalink Blame History

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.

  2. You will need to install doxypypy to format python comments appropriately. Install it from here.

Note: You will need both doxygen and doxypypy to be in your PATH 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.

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.