Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python class only with async methods support #8336

Closed
yosshy opened this issue Jan 15, 2021 · 2 comments
Closed

Python class only with async methods support #8336

yosshy opened this issue Jan 15, 2021 · 2 comments
Labels
enhancement a request to enhance doxygen, not a bug Python

Comments

@yosshy
Copy link
Contributor

yosshy commented Jan 15, 2021

Describe the bug
Doxygen doesn't generate a class reference of python properly if the class had multiple async methods and no sync method. It generates one with ONLY async method name.

Expected behavior
Doxygen generates a class reference with multiple async method names properly.

To Reproduce

  1. Create a working directory and enter it with cd command.
  2. Put a sample source code like below:
    ## Documentation for an async class.
    #  More details.
    class AsyncPyClass:
    
        ## Documentation for a method_a.
        #  @param self The object pointer.
        async def method_a(self):
            pass
    
        ## Documentation for a method_b.
        #  @param self The object pointer.
        async def method_b(self):
            pass
    
        ## Documentation for a method_c.
        #  @param self The object pointer.
        async def method_c(self):
            pass
    
  3. Run "doxygen -g Doxyfile" to create a configuration file.
  4. Run "doxygen Doxyfile" to generate documents.

Version
1.9.2 (3170939*)

yosshy added a commit to yosshy/doxygen that referenced this issue Jan 15, 2021
@albert-github albert-github added enhancement a request to enhance doxygen, not a bug Python labels Jan 15, 2021
yosshy added a commit to yosshy/doxygen that referenced this issue Jan 18, 2021
doxygen added a commit that referenced this issue Apr 29, 2021
issue #8336 Python class only with async methods support
@albert-github
Copy link
Collaborator

Code has been integrated in master on github (please don't close the issue as this will be done at the moment of an official release).

@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Apr 30, 2021
@doxygen
Copy link
Owner

doxygen commented Aug 18, 2021

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.9.2.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Aug 18, 2021
@doxygen doxygen closed this as completed Aug 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement a request to enhance doxygen, not a bug Python
Projects
None yet
Development

No branches or pull requests

3 participants