coalib.bearlib.languages.documentation.DocumentationComment

Complexity

Total Complexity

2

Size/Duplication

Total Lines	25
Duplicated Lines	0 %

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__str__()	0	2	1
A	__init__()	0	14	1

from coalib.misc.Decorators import generate_eq, generate_repr


@generate_repr()
@generate_eq("documentation", "docstyle", "marker", "range")
class DocumentationComment:
    """
    The DocumentationComment holds information about a documentation comment
    inside source-code, like position, docstyle etc.
    """

    def __init__(self, documentation, docstyle, marker, range):
        """
        Instantiates a new DocumentationComment.

        :param documentation: The documentation text.
        :param docstyle:      The DocstyleDefinition.
        :param marker:        The specific set of marker strings that
                              identified this documentation comment.
        :param range:         The position range of type TextRange.
        """
        self.documentation = documentation
        self.docstyle = docstyle
        self.marker = marker
        self.range = range

    def __str__(self):
        return self.documentation