Provide doxygen specific macro for non-existent symbols

[korydraughn]

• master
• 4-2-stable

---

Enhancement

There are cases where documentation exists, but is not included in the doxygen output. This is due to how doxygen determines what should be included by default.

Doxygen will not include the documentation because the symbol has not been declared. To get around this, the doxygen config file needs to define a special iRODS macro. This macro would cause the missing symbols to appear, but only for documentation purposes.

Proposed Macro: IRODS_FOR_DOXYGEN

Example

#ifdef IRODS_FOR_DOXYGEN
/// \brief An important function that fixes all of your data management needs!
///
/// \param[in] _arg Some JSON data describing the problem.
///
/// \return A solution
auto a_symbol_that_is_only_needed_for_documentation(std::string_view _arg) -> solution;
#endif // IRODS_FOR_DOXYGEN