Hi Lachlan,
The command style doesn't seem to be configurable, but there's some
auto-detection going on which tries to be smart. If you start the
comment with a /*! (instead of double asterisk), then the generated
Doxygen commands will use the backslash style instead of the @ style.
Similarly, one could use //! or /// as the opening line, and the
auto-generated docs will follow suit and also use the backslash style
commands.
FWIW, looks like DoxygenGenerator[1] is the relevant plugin, and I don't
see any way to user-configure anything here. The styleMark() method
returns the command prefix. doxygenStyle() in the helper code[2]
determines the comments style.
Hope that helps,
-Max
[1]:
<https://code.woboq.org/qt5/qt-creator/src/plugins/cpptools/doxygengenerator.cpp.html>
[2]:
<https://code.woboq.org/qt5/qt-creator/src/plugins/cppeditor/cppdocumentationcommenthelper.cpp.html>
On 7/26/2020 9:17 PM, Hetherton, Lachlan (Data61, Docklands GS) wrote:
Hi there,
I’ve tried finding this information on the interwebs elsewhere but can’t, so
figured I’d ask here.
QtCreator has a handy checkbox to add auto generation of doxygen commands (e.g.
param, return etc). Is there any way to make it add backslash style commands
instead of @-style? i.e. it currently inserts this:
/**
* @param first The first param
* @param second The second param
*/
Whereas to match our coding style I’d really like to see:
/**
* \param first The first param
* \param second The second param
*/
Any ideas?
Thanks for your help,
Lachlan Hetherton
Principal Software Engineer, Workspace <https://research.csiro.au/workspace>
Data61 | CSIRO
[email protected] | +613 9545 8041
Door 34, Goods Shed North, Village Street, Docklands VIC 3008
CSIRO acknowledges the Traditional Owners of the land, sea and waters, of the
area that we live and work on across Australia. We acknowledge their continuing
connection to their culture and we pay our respects to their Elders past and
present.
Please consider the environment before printing this email.
CSIRO Australia’s National Science Agency | csiro.au <https://www.csiro.au>
_______________________________________________
Interest mailing list
[email protected]
https://lists.qt-project.org/listinfo/interest
