(docs): documentation of core::memory is not good enough
Summary
The fwMemory
lib is not properly documented:
- Many classes/structs/enums are just not documented, or have plain useless documentation.
- The nested namespaces are not documented either, which makes them inaccessible from the
core::memory
namespace doxygen page.
Steps to reproduce
Build the doxygen/docset.
Dev environment
Irrelevant
What is the current bug behavior?
See above.
What is the expected correct behavior?
fwMemory
should be properly documented.
Relevant logs and/or screenshots
As you can see, the nested namespaces (policy
, stream
, tools
, ...) are indexed in the doxygen and reachable through the search feature, but they are not visible in the main namespace page. Some missing documentation can also be seen on the screenshot.
Possible fixes
The low hanging fruit would be properly documenting the namespaces in Namespace.hpp
to at least make the fwMemory
namespace page somewhat complete. Ideally, the rest of the library should be (better) documented.