All public API header files, functions, structs, enums, etc., should be documented with Doxygen comment blocks, as Pacemaker’s
online API documentation is automatically generated via Doxygen. It is helpful to document private symbols in the same way, with an
\internal
tag in the Doxygen comment.