Feature Request — Support for doxygen Documentation

[alexdima]

Moved from microsoft/vscode#25231
From @rei-vilo

---

Doxygen provides a very nice way of adding documentation to the code thanks to keywords.

Some IDEs support Doxygen natively and display the documentation related to the function being typed in.

[hoffmael]

Adding my vote to this one. Doxygen would be very useful and I'd hope for it being as robust as the JsDoc implementation.

[benjaminjack]

I would also really like to see this feature implemented. Doxygen support for C++ is the one feature that's really feels missing coming over from Atom.

[trybik]

I fourth that.. had to go back to Eclipse to generate some of them docs

[aa6moham]

I also feel that adding Doxygen support in VS code would be very beneficial !

[cesar-pa]

The lack of Doxygen block generation is the only thing stopping me to leave Sublime. I need to have something like DocBlockr.

[HallEffect]

I'd like to have something like DoxyDoxygen in Sublime to generate comment by Alt+Q

[Ikarium]

ADDITIONALLY:

• Syntax highlighting
• (smart) Docstring generation (customisable)
• Ability to run Doxygen and Doxyfile configurator from the ide.

I don't know what from that could be done by a plugin.

[rei-vilo]

Any update on that feature request? Thanks!

[sean-mcmanus]

@rei-vilo Comments attached to variables are part of our ongoing work of porting code from VS. If you're asking for doxygen support that don't exist in VS code itself, then that would not something we currently have plans to add.

[rei-vilo]

Good to know, thank you for the feed-back.

[Trevinlc1997]

Definitely want! I hope this can come soon,

[moof2k]

+1

This was my favorite feature of Visual Studio and Visual Assist: https://docs.wholetomato.com/default.asp?W206

[loucyx]

👍

[Trevinlc1997]

I just want to bump and say this would be really helpful as documenting code without Doxygen just feels awkward, to be honest.

I'll have my friend learn the VSCode API just to try and implement something like requested ;)

[rainaby]

Do we have any updates on this?

[sean-mcmanus]

@rainaby No updates. We haven't done any work on this feature and it's not on our schedule yet.

[creikey]

Couldn't this be a simple extension?

[cschlosser]

Couldn't this be a simple extension?

I tried and no it is not really. We're missing features from the language server. The Typescript server has the necessary information but the C/C++ one doesn't. If the information would be available it would be super eayy.

I'm really interested in this and the only way right now to do it would be to do some form of heuristic analysis on the source code (essentially reimplementing the whole Doxygen engine and keeping a seperate data base like intellisense) which is quite error prone.

[rainaby]

Is there a hack for now to get to work? Like using 2 different plugins to get it to work?

[Tanja-4732]

+1

Please have it support syntax highlighting inside of the Doxygen comments.
That'd be great.

❤️ VS ode

PS: Consider adding an extension-request-tag or something like that to this issue, in case you aren't interested in implementing this functionality natively.

[LeThiHyVong]

@Bernd-L I am using an alternative syntax parser (Reloaded C/C++ with Reloaded Themes), hope it usable.

[Tanja-4732]

@LeThiHyVong Yes, I've been using it too, however, it still lacks Doxygen-command auto-completion (=IntelliSense). Also, it can't display a popover-like bubble with the documentation of a method. (or something else).

The functionality described above really needs to be implemented into the Microsoft C++ plugin.

[michelleangela]

Example of Doxygen comments displayed on tooltip by the C/C++ extension:

[michelleangela]

If you would like for the C/C++ extension to also generate stub Doxygen comments, please upvote the "Feature request - Doxygen stub generation" at #5683. Votes on features will help determine a feature's priority against other features or work items.

[sean-mcmanus]

Doxygen comment support in hover, signature help, and completion is available now with https://github.com/microsoft/vscode-cpptools/releases/tag/0.29.0-insiders .

[rewrking]

Works awesome so far! I'm now spending an evening documenting my code... any plan to add support for @tparam (template parameters) though?

[ben-edna]

Great! Minor detail, our code-base uses the Qt-Style exclamation mark docblocks (/*! instead of /**), and the exclamation mark is shown in the hover.

[ebinans]

Fantastic! Another small detail - documentation block after members show /<, !< or < depending on chosen syntax.
https://www.doxygen.nl/manual/docblocks.html#memberdoc

[michelleangela]

Works awesome so far! I'm now spending an evening documenting my code... any plan to add support for @tparam (template parameters) though?

The work to support @tparam is in progress.

[michelleangela]

Great! Minor detail, our code-base uses the Qt-Style exclamation mark docblocks (/*! instead of /**), and the exclamation mark is shown in the hover.

The work to support Qt-Style exclamation mark /*! is in progress.

[Boddlnagg]

We have configured Doxygen to use \par instead of \param, can that somehow also be supported (probably through some setting?).
Also, for some reason we put our Doxygen comments in between the function signature and the opening {. Doxygen parses that just fine ... will that work here as well?

[michelleangela]

We have configured Doxygen to use \par instead of \param, can that somehow also be supported (probably through some setting?).
Also, for some reason we put our Doxygen comments in between the function signature and the opening {. Doxygen parses that just fine ... will that work here as well?

@Boddlnagg , I created a new issue for your feature request at #5700

[michelleangela]

Fantastic! Another small detail - documentation block after members show /<, !< or < depending on chosen syntax.
https://www.doxygen.nl/manual/docblocks.html#memberdoc

@ebinans , I created a new issue for your feature request at #5701

[jhortenstine]

Is it possible to leave the commands that are not being converted? We use \note, \pre, and \post. The current behavior is that they don't show up in the tool tip at all.

[ben-edna]

We sometimes use the \copydoc to not duplicate documentation when it is not needed. It would be great if the documentation of the mentioned symbol would be used for the tooltip.

[carlolars]

Looks great! Just one little detail.

We trim trailing whitespace in our source files, so if a doxy-comment is split in two lines then there is no space between the last word on the first line and the first word on the second line.

/**
 * Comment in
 * correct format
 */

becomes Comment incorrect format instead of Comment in correct format.

[sean-mcmanus]

@carlolars What's the repro for that space issue? I'm not reproing it.

[carlolars]

@carlolars What's the repro for that space issue? I'm not reproing it.

It happens for functions if it has @return and/or @param, the examples below are failing for me.

/**
 * Comment in
 * correct format.
 *
 * @param arg1
 * @return int
 */
int func1(int arg1)
{
    return arg1;
}

/**
 * Comment in
 * correct format.
 *
 * @return int
 */
int func2(void)
{
    return 2;
}

/**
 * Comment in
 * correct format.
 *
 * @param arg1
 */
void func3(int arg1)
{
    (void)arg1;
}

[michelleangela]

@carlolars @sean-mcmanus
I was able to repro the issue on Visual Studio.

Edit:
I created a new issue #5741 for this and filed an issue on Visual Studio.

[magdumnikhil]

Only doxygen comments above function definition are parsed and shown over tooltip. Comments above function declaration are ignored.

Is there any setting which decides this?