Issue 556: add missing classes and functions to the sphinx API reference documentation

[jkotan]

It resolves #556 by add missing classes and functions to the sphinx API reference documentation.

It looks like in the current configuration doxygen/breathe/sphinx cannot link correctly operator&

/home/jenkins/build/doc/source/api_reference/namespace_file.rst:45: WARNING: doxygenfunction: Cannot find function "hdf5::file::operator&" in doxygen xml output for project "h5cpp" from directory: /home/jenkins/build/doc/source/../doxygen_xml
/home/jenkins/build/doc/source/api_reference/namespace_file.rst:47: WARNING: doxygenfunction: Cannot find function "hdf5::file::operator&" in doxygen xml output for project "h5cpp" from directory: /home/jenkins/build/doc/source/../doxygen_xml
/home/jenkins/build/doc/source/api_reference/namespace_file.rst:49: WARNING: doxygenfunction: Cannot find function "hdf5::file::operator&" in doxygen xml output for project "h5cpp" from directory: /home/jenkins/build/doc/source/../doxygen_xml
/home/jenkins/build/doc/source/api_reference/namespace_file.rst:66: WARNING: doxygenfunction: Cannot find function "hdf5::file::operator&" in doxygen xml output for project "h5cpp" from directory: /home/jenkins/build/doc/source/../doxygen_xml
/home/jenkins/build/doc/source/api_reference/namespace_file.rst:68: WARNING: doxygenfunction: Cannot find function "hdf5::file::operator&" in doxygen xml output for project "h5cpp" from directory: /home/jenkins/build/doc/source/../doxygen_xml
/home/jenkins/build/doc/source/api_reference/namespace_file.rst:70: WARNING: doxygenfunction: Cannot find function "hdf5::file::operator&" in doxygen xml output for project "h5cpp" from directory: /home/jenkins/build/doc/source/../doxygen_xml
/home/jenkins/build/doc/source/api_reference/namespace_file.rst:87: WARNING: doxygenfunction: Cannot find function "hdf5::file::operator&" in doxygen xml output for project "h5cpp" from directory: /home/jenkins/build/doc/source/../doxygen_xml
/home/jenkins/build/doc/source/api_reference/namespace_file.rst:89: WARNING: doxygenfunction: Cannot find function "hdf5::file::operator&" in doxygen xml output for project "h5cpp" from directory: /home/jenkins/build/doc/source/../doxygen_xml
/home/jenkins/build/doc/source/api_reference/namespace_file.rst:91: WARNING: doxygenfunction: Cannot find function "hdf5::file::operator&" in doxygen xml output for project "h5cpp" from directory: /home/jenkins/build/doc/source/../doxygen_xml
/home/jenkins/build/doc/source/api_reference/namespace_property.rst:198: WARNING: doxygenfunction: Cannot find function "hdf5::property::operator&" in doxygen xml output for project "h5cpp" from directory: /home/jenkins/build/doc/source/../doxygen_xml
/home/jenkins/build/doc/source/api_reference/namespace_property.rst:200: WARNING: doxygenfunction: Cannot find function "hdf5::property::operator&" in doxygen xml output for project "h5cpp" from directory: /home/jenkins/build/doc/source/../doxygen_xml
/home/jenkins/build/doc/source/api_reference/namespace_property.rst:202: WARNING: doxygenfunction: Cannot find function "hdf5::property::operator&" in doxygen xml output for project "h5cpp" from directory: /home/jenkins/build/doc/source/../doxygen_xml
/home/jenkins/build/doc/source/api_reference/namespace_property.rst:204: WARNING: doxygenfunction: Cannot find function "hdf5::property::operator&" in doxygen xml output for project "h5cpp" from directory: /home/jenkins/build/doc/source/../doxygen_xml
looking for now-outdated files... none found

It works without warnings on my local installation on debian11 so to fix it I propose to open a new ticket to found doxygen/breathe/sphinx versions working together correctly.

[jkotan]

It works without warnings on my local installation on debian11 so to fix it I propose to open a new ticket to found doxygen/breathe/sphinx versions working together correctly.

I've made some tests with different versions of breathe and sphinx but the warnings were still there so I suspect one needs to upgrade doxygen to v1.9.1 or v1.9.2

[jkotan]

It looks like the above mentioned doxygen related to operator& was fixed in doxygen 1.8.16 and ubuntu 20.04 has doxygen 1.8.17 so to workaround the problem I've changed documentation_os to ubuntu2004-release