Skip to content

Multi-line doc not recognized in Python class field #10240

@lelegard

Description

@lelegard

In Python, multi-line doc is recognized on class, class method, but not class fields.

Sample code:

##
# Class multi-line doc
#
class C:
    ##
    # Constructor multi-line doc
    #
    def __init__(self):
        ## field one-line doc
        self.a = None
        ##
        # field multi-line doc
        #
        self.b = None
        ## field one-line doc
        self.c = None

For fields, only one-line doc are recognized. The doc for field b is not recognized:

$ ../doxygen-master/build/bin/doxygen 
test.py:11: warning: Member b (variable) of class test.C is not documented.
$
$ ../doxygen-master/build/bin/doxygen --version
1.9.8 (27ba0983fdcc4b7b836e06fef90e05400d8351c8)

Looking at the generated HTML, b has no documentation.

Is this expected?

This has been reproduced with version 1.9.4, 1.9.5, 1.9.6, 1.9.7, and current master of the repo.

Reproducer: doxybug4.zip

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions