https://github.com/sdslabs/rubeus-docs
Documentation website dump of the various versions of Rubeus Engine
https://github.com/sdslabs/rubeus-docs
documentation doxygen-documentation
Last synced: 3 months ago
JSON representation
Documentation website dump of the various versions of Rubeus Engine
- Host: GitHub
- URL: https://github.com/sdslabs/rubeus-docs
- Owner: sdslabs
- Created: 2019-05-06T12:07:27.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-10T16:13:14.000Z (over 6 years ago)
- Last Synced: 2025-02-23T20:32:02.414Z (over 1 year ago)
- Topics: documentation, doxygen-documentation
- Language: HTML
- Homepage: https://blog.sdslabs.co/Rubeus-Docs
- Size: 778 KB
- Stars: 0
- Watchers: 12
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Rubeus: API Documentation
Created by SDSLabs with :heart:
Every large scale project is incomplete without an exhaustive, and efficient documentation.
Getting started: https://github.com/sdslabs/Rubeus/wiki
API documentation: https://blog.sdslabs.co/Rubeus/
## Workflow
Rubeus uses Java-Doc style commenting and uses a combination of Doxygen and Moxygen to gather
all the code documentation into a single markdown file.
### 1. Edit the documentation
Rubeus aims at documenting all:
* classes
* structures
* member variables
* member functions
* constructors
* destructors
* enumerations
* unions
* macros
* variables
* functions
* *.h files
* *.cpp files
### 2. Install Doxygen and a custom Doxygen theme
Install [Doxygen](https://www.stack.nl/~dimitri/doxygen/manual/install.html).
Install the [M.CSS Documentation Doxygen Theme](https://mcss.mosra.cz/doxygen/). Before you go, `Doxyfile` in this directory already has the necessary configurations for a successful build.
### 3. Follow the build steps as provided for installing the theme
### 4. Once reviewed, push your changes, get them merged to `master` and review them at https://blog.sdslabs.co/Rubeus