Doxygen docstring displayable in vscode

Question

I have a Python code, and I recently discovered Doxygen which generates the documentation automatically from the source code. If I understood correctly, to make the generated code well detected by Doxygen, the doc string should be like this :

def f(self, x, y):
    """!Compute the sum

    @param x first number
    @param y second number
    @return sum of x and y
    """
    return x + y

But with Vscode, the snippet, when I pointto this method, is no longer displayed correctly (cf Fig. 1)

When I enter the docstring in this format

"""Compute the sum

Parameters
----------
x : int
    first number
y : int
    second number

Returns
-------
    int
    sum of x and y
"""

it is correctly displayed in VScode (Fig. 2)

But with this second method, Doxygen no longer recognizes the parameters, and in the generated HTML page, the docstring is just displayed in verbatim mode (like with three ` in markdown)

Is there a way to combine both ways? So that Doxygen correctly catches the parameters as well as VSCode?

Which version of doxygen are you using? did you have a look at the doxygen setting PYTHON_DOCSTRING = NO? — albert
– albert, Commented Apr 25 at 8:29
I did try that, but there it just converts this into markdown, and no longer lists the arguments in a pretty way (cf gist.github.com/user-attachments/assets/…) — Thomas
– Thomas, Commented Apr 25 at 8:37
Indeed as the x : int first parameter is not something understood by doxygen as being special (and I think in python / vscode there are also no checks on completeness as there would have been when using \param in a doxygen run.) — albert
– albert, Commented Apr 25 at 8:45

Naveed Ahmed · Accepted Answer · 2025-04-25 08:18:36Z

0

As mentioned in the documentation, there is also another way to document Python code using comments that start with "##" or "##<". So, your script might look somewhat like this

def f(self, x, y):
    ## Compute the sum

    # @param x first number
    # @param y second number
    # @return sum of x and y
    
    return x + y

answered Apr 25 at 8:18

Naveed Ahmed

4642 silver badges17 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

albert Apr 25 at 8:30

See my comment ate the original question.

Thomas Apr 25 at 8:38

This is the same problem as before : Doxygen works well, but vscode no longer recognizes the parameters

Naveed Ahmed Apr 25 at 8:43

Do you have doxygen extension installed in vs code?

Thomas Apr 25 at 11:30

@NaveedAhmed which extension ? I have this one marketplace.visualstudio.com/items/?itemName=bbenoist.Doxygen, but is does not display correctly in VScode. Is there another extension ? I quickly looked at the list in the market, but without success yet...

Naveed Ahmed Apr 25 at 12:38

In the left vertical bar VSCode, click the extensions icon and search for doxygen. You will get many options, just install the one you thing would work for you.

Collectives™ on Stack Overflow

Doxygen docstring displayable in vscode

1 Answer 1

5 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

5 Comments

Your Answer

Sign up or log in

Post as a guest

Related