search

GameDevTecnico / cubos

A still very barebones game engine focused on voxels and data-oriented programming
https://cubosengine.org
MIT License
83 stars 36 forks source link

Fix documentation include paths #677

Open RiscadoA opened 1 year ago

RiscadoA commented 1 year ago

Description

Currently all class pages show an include path which ommits the first cubos/ dir.

Reproduce

Open any class page in the docs.

Expected behaviour

Should include cubos/, e.g., cubos/engine/renderer/plugin.hpp.

Screenshots

image

RiscadoA commented 7 months ago

The reason this is happening is because we have the Doxygen STRIP_FROM_PATH variable set to exclude the cubos/ directory.

At first it seems that removing it would suffice, but: there are two cubos directories (core/include/cubos and engine/include/cubos), which to the user seem identical, but Doxygen distinguishes them. The result of doing this is: image Relevant issue: https://github.com/doxygen/doxygen/issues/8318

One possible mentioned workaround is adding an extra step to the docs generation target where we first copy all source files to a single directory, and then doxygen runs on it.