Feneric / doxypypy

A more Pythonic version of doxypy, a Doxygen filter for Python.
GNU General Public License v2.0
149 stars 49 forks source link

Multiple lines for attributes #67

Open Hecatron opened 5 years ago

Hecatron commented 5 years ago

Hi, This might be related to https://github.com/Feneric/doxypypy/pull/42 but do we know if there's a way to handle attributes with multiple lines? such as the below

class TestClass(object):
    """Test Class.

    Attributes:
        value1: This is a test.
        value2: This is a 2nd test.
        value3: This is a multiple line attribute
            This is a second line
    """
Hecatron commented 5 years ago

Okay one way around this is to use

class TestClass(object):
    """Test Class.

    Attributes:
        value1: This is a test.
        value2: This is a 2nd test.
    """

    def __init__(self):
        self.value1 = 'some value'
        self.value2 = 'some value'

        ## @property value3
        # This is a multiple line attribute. <br>
        # This is a second line.
        self.value3 = 'some value'