What does “\p” in comments means?

Question

During reading LLVM source code, I find something different in comments, e.g.

/// If \p DebugLogging is true, we'll log our progress to llvm::dbgs().

What does \p means here?

Answer 1

LLVM uses Doxygen for generating documentation, the /// marker is one of the many ways of creating a special comment block that Doxygen will parse to form documentation.

Within a special comment block, \p is simply one of the mark-up commands, this particular one renders the following word in typewriter font (fixed rather than proportional). The \c option is an alias for the same thing.

Answer 2

3 slashes is one of the ways that doxygen comments are identified. The \p tag has some meaning, see it's documentation: https://www.doxygen.nl/manual/commands.html#cmdp

Displays the parameter using a typewriter font. You can use this command to refer to member function parameters in the running text.