Fix doxygen errors in the module

signetlabdei / lorawan

An ns-3 module for simulation of LoRaWAN networks

GNU General Public License v2.0

182 stars 130 forks source link

Fix doxygen errors in the module #144

Closed non-det-alle closed 10 months ago

non-det-alle commented 10 months ago

Fix problems causing errors when building doxygen:

Add parent declaration for TypeId of all classes
Add __FILE__ param to CommandLine constructor in examples

Now running ./ns3 docs doxygen will not fail.

pagmatt commented 10 months ago

Does this fix any of the CI errors? It's hard for me to check this having split the PRs

non-det-alle commented 10 months ago

Yes, it does as a consequence, but this fixes the more general problem that the documentation was not building when manually run. You can check by running ./ns3 docs doxygen or ./ns3 docs all.

Strictly speaking, the only required change to fix building the docs are the changes in the model's files. I also preemptively modified the examples because otherwise, once they are added to the module's tests (see #145), they would make doxygen fail once again.