CODEWITHSUNDEEP
visual-studiovisual-studio-2015intellisensedoxygen
allo
allo

Reputation: 4236

Get Visual Studio 2015 to recognize Doxygen comments

I have a function documented like this:

/**
 * Does something useful
 */
int foo(Bar bar)
{
    // my function
}

But Intellisense doesn't display it when i hover the function in other places. When i hover it at the definition, i see * Does something useful, which isn't right either (the star should not be in there). Doxygen runs fine and eclipse CDT displays the doc comments as you would expect.

Upvotes: 2

Views: 3327

Answers (1)

MxNx
MxNx

Reputation: 1374

As of version 2016.2, JetBrains ReSharper provides support for Doxygen documents in C++ files. From this blog post I quote:

Doxygen is arguably the most popular format and tool for code documentation in the C++ world. ReSharper C++ now understands Doxygen syntax, and provides several key features to facilitate editing of documentation blocks.

  • Typing assist helps with creating new comment blocks and maintaining the structure of existing ones.
  • Code completion suggests Doxygen commands with accompanying short descriptions.
  • Function parameter references introduced with \param commands will be reported by Find Usages and will get updated when Rename is used to change a function parameter’s name.
  • Warnings are issued when function parameter references do not resolve to an existing function parameter.
  • Documentation generation: You can now generate documentation for C++ declarators, classes and macro definitions.
  • Quick Documentation: Documentation now works in C++. The documentation pop-up (bound to Ctrl+Shift+F1 in the Visual Studio scheme or Ctrl+Q in the IntelliJ IDEA scheme) will display documentation from Doxygen comment blocks, or the symbol’s signature if no documentation is found.

It should be noted that this product is not free and to use it, you need to procure a license.

Upvotes: 2

Related Questions