search

LancePutnam / Gamma

Generic (Sound) Synthesis Library
Other
458 stars 54 forks source link

@param to \param? #16

Closed gitelope closed 12 years ago

gitelope commented 12 years ago

Lance, what do you think about replacing the ampersand with a backslash for the sake of consistency?

LancePutnam commented 12 years ago

You mean replace @ with \? Sounds reasonable as long as they are interchangeable. Strangely, the doxygen examples always use "@param".

gitelope commented 12 years ago

I get the impression from the site below that you can use @ and \ interchangeably: http://www.stack.nl/~dimitri/doxygen/commands.html

It seems to work so I've replaced the at signs (not ampersands, as you point out) in the following Doxygen comment tags: @param[in] @param[out] @param[in,out]

These were the only remaining Doxygen comments using @'s. Now all the comments use backslashes.