https://github.com/obengine/obidog
Öbengine BInding and DOcumentation Generator
https://github.com/obengine/obidog
bulma-css documentation-generator doxygen hacktoberfest lua obengine
Last synced: 9 months ago
JSON representation
Öbengine BInding and DOcumentation Generator
- Host: GitHub
- URL: https://github.com/obengine/obidog
- Owner: ObEngine
- Created: 2019-02-06T22:30:49.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-19T02:25:35.000Z (over 2 years ago)
- Last Synced: 2025-04-03T01:04:52.757Z (10 months ago)
- Topics: bulma-css, documentation-generator, doxygen, hacktoberfest, lua, obengine
- Language: Python
- Homepage: https://obengine.io
- Size: 582 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Obidog
Öbengine's BIndings and DOcumentation Generator (work in progress)
**[ÖbEngine repository](https://github.com/Sygmei/ObEngine)**
Obidog has two uses :
- Generating ÖbEngine bindings
- Generating ÖbEngine documentation
## Requirements
Obidog has the following requirements :
- Python > 3.6 (+ install the Obidog package using `pip install -e .` if you cloned this repository)
- lxml
- GitPython
- Doxygen (needs to be in `PATH`)
- Git (optional, see [below](#cloning-repository))
### Cloning repository
To make the script run faster, you should export the following environment variable : `OBENGINE_GIT_DIRECTORY`, if you don't export it though, it's fine, Obidog will clone the repository in a temporary folder (it requires you to have `git` in `PATH`).
## Bindings generator
### Introduction
ÖbEngine embeds scripting languages to allow the user to create games with more flexibility and safety (it only supports Lua as of today).
Embedding a scripting language inside a C++ application is not free though, as C++ lacks any kind of reflection capability, it requires the user to manually bind each function/class/enum/... to the scripting language's virtual machine.
Doing such a task takes a lot of time, is error-prone and is really boring.
That's where Obidog comes into action : it will use Doxygen as a reflection tool (thanks to Doxygen's XML output) and automatically generates all the gluecode.
### Usage
Just run `obidog bindings` and it will generate all the ÖbEngine bindings into the `output/` folder.
The output will have the following structure :
```
output/
include/
Bindings/
Namespace1/
ClassHuman.hpp
Namespace2/
ClassPerson.hpp
...
NamespaceN/
src/
Bindings/
Namespace1/
ClassHuman.cpp
Namespace2/
ClassPerson.cpp
...
NamespaceN/
```
### Flavours
The Obidog bindings generator currently supports two flavours
- sol3 (wip)
- kaguya (deprecated)
New flavours can be added easily in the `obidog/generators/bindings_flavours` folder.
It will maybe support the following flavours in the future when ÖbEngine is mature enough.
- Wrenpp
- GuraX
- Chaiscript
- pybind11
## Documentation generator
### Introduction
ÖbEngine C++ code is already documented using Doxygen's notation (documentation in comment).
Doxygen parses these comments and generate a fully fledged documentation website from it.
This is really practical from the user's point of view as any user can explore the codebase quickly, check-out which function exists, what kind of types a function takes as parameters, get more information about what a function does and get examples on how to use it.
All of that is great, but there is a catch: if the user uses the scripting language, it is not C++ anymore and therefore, the user won't be able to use the C++ documentation anymore (not the same symbols / types).
That's where Obidog comes into action (again!), it will create try to generate a documentation for the target scripting language using the Doxygen XML and the generated bindings, translating symbols and types on the go to generate a coherant and nice looking documentation website.
### Usage
Just run `obidog documentation` and it will generate all the ÖbEngine documentation into the `docs/` folder.
### Template customisation
(WIP)
## Extra informations
*The project might be renamed to Obidog (Öbengine BIndings & DOcumentation Generator) so the logo could be a mix of Obi-wan Kenobi, an eggplant and a dog*