What is the purpose of the GENERATING_DOCUMENTATION macro definition in asio?

recently, I was looking at the source code of asio. The specific meaning of a macro definition is unknown. There is no relevant record on domestic and foreign websites. Specifically, this macro: GENERATING_DOCUMENTATION

Mar.02,2021

I wrote to Chris, the author of asio, and the reply I got was: Asio uses Doxygen to generate documentation directly from the Asio source code.. Sometimes the generated documentation needs to be different to the real CPP implementation. Usually this happens when I want the documentation to contain simpler class or function declarations. The GENERATING_DOCUMENTATION macro is used to protect source code that should only be seen by Doxygen.

Menu