As opposed to the official documentation, this program generates documentation that
-
lists every class method (dedicated protobuf message is not a requirement)
-
links c++ defintions and usage examples.
- Clone or update bess repository,
- Compile bess with container_build,
- Extract documentation from protobuf messages,
- Collect modules and their methods by running bessd in a container,
- Find method definitions by running gdb,
- Write a dummy module (globals.py).
To remove the software, you also need to remove some docker images.
$ docker image rm gen-bess-doc-globals
$ docker image rm nefelinetworks/bess_build:latest-git
$ docker image rm nefelinetworks/bess_build
$ docker image rm pseudomuto/protoc-gen-doc
At least the bess language server uses it.