CODEWITHSUNDEEP
doxygenclion
lorisleitner
lorisleitner

Reputation: 698

Doxygen - Backslashes in comment

I want to add a Windows path that contains backslashes to a doxygen comment like this:

/**
 *
 * Returns common AppData directory, usually C:\ProgramData\
 *
 */

I tried it with two backslashes but CLion always displays it as new section. Is this a problem with CLion or am I doing it wrong?

Upvotes: 0

Views: 989

Answers (1)

albert
albert

Reputation: 9057

Doxygen will see the \ProgramData as a possible command and leave it out. Solutions for this are either:

  • escaping the backslash so: C:\\ProgramData\\
  • using backticks, this will also change the font (something I would prefer to signal that it is a computer directory: 
    `C:\ProgramData\`

Upvotes: 1

Related Questions