multiscale / muscle3

The third major version of the MUltiScale Coupling Library and Environment
Apache License 2.0
25 stars 13 forks source link

C++ API documentation mentions libmuscle::impl #242

Closed LourensVeen closed 1 year ago

LourensVeen commented 1 year ago

The C++ API implementation lists classes in the libmuscle::impl namespace. This is where they are, but not where we export them and would like to show them in the docs. Doxygen doesn't seem to get that though.

This has already caused one user to use libmuscle::impl::Instance, which then broke when 0.7.0 was released and changed the name of the impl namespace for MPI models. So it would be nice if it could be somehow fixed.

Maybe there's a way to specify the name of the class explicitly? Or we can filter the Sphinx output before it goes to HTML? I've already tried hacking up Doxygen's XML output, but doing that in a way that doesn't create a bunch of error messages was beyond me.

LourensVeen commented 1 year ago

Released with 0.7.0.