Skip to content

Commit 1d049ed

Browse files
authored
Enable doxygen CI check on noble (#1129)
Signed-off-by: Ian Chen <[email protected]>
1 parent d65d4dc commit 1d049ed

File tree

3 files changed

+3
-6
lines changed

3 files changed

+3
-6
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ jobs:
2222
# codecov-enabled: true
2323
cppcheck-enabled: true
2424
cpplint-enabled: true
25-
# doxygen-enabled: true
25+
doxygen-enabled: true

tutorials/03_rendering_plugins.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ It allows users to select from multiple supported rendering engines based on the
99
Its plugin interface loads rendering engines at runtime.
1010
It is also possible to integrate your own selected rendering engine by writing a compatible plugin interface.
1111

12-
#### How to Write Your Own Rendering Engine Plugin
12+
### How to Write Your Own Rendering Engine Plugin
1313

1414
A mocked example of a custom rendering engine plugin can be found [here](https://github.com/gazebosim/gz-rendering/tree/main/examples/hello_world_plugin). In order
1515
to make your own custom rendering engine, this example is a good starting point. There are a few key things which will need to be done in order for a custom rendering engine to function:
@@ -20,7 +20,7 @@ to make your own custom rendering engine, this example is a good starting point.
2020

2121
Finally, for your custom rendering engine to actually have any functionality and at minimum, display something in a window, you will need to implement your own `Scene` and `Camera` classes, which inherit from and implement the pure virtual functions of [`gz::rendering::Scene`](https://github.com/gazebosim/gz-rendering/blob/main/include/gz/rendering/Scene.hh) and [`gz::rendering::Camera`](https://github.com/gazebosim/gz-rendering/blob/main/include/gz/rendering/Camera.hh), respectively. The mocked example simply returns `nullptr` for its `CreateSceneImpl(...)` function, so it may be useful to look at the current `Scene` implementations for the other rendering engines within `gz::rendering` such as [`OGRE`](https://github.com/gazebosim/gz-rendering/blob/main/ogre/src/OgreScene.cc) or [`OGRE2`](https://github.com/gazebosim/gz-rendering/blob/main/ogre2/src/Ogre2Scene.cc). Likewise, it may be helpful to look at the `Camera` implementations from [`OGRE`](https://github.com/gazebosim/gz-rendering/blob/main/ogre/src/OgreCamera.cc) and [`OGRE2`](https://github.com/gazebosim/gz-rendering/blob/main/ogre2/src/Ogre2Camera.cc)
2222

23-
#### Building and Running Your Rendering Engine Plugin with Gazebo
23+
### Building and Running Your Rendering Engine Plugin with Gazebo
2424

2525
Once you have your own rendering plugin written, you can build it similarly to how the example is built. It may be helpful to look at the [`CMakeLists.txt`](https://github.com/gazebosim/gz-rendering/tree/main/examples/hello_world_plugin) from the example as it contains the boilerplate code needed to get a custom rendering engine plugin built.
2626

tutorials/index.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)