coala-analyzer / coala

                    self.ReturnValue(desc=' something2 ')]

        self.check_docstring(doc, expected)

    def test_python_default(self):

        data = load_testdata("default.py")

        parsed_docs = [doc.parse() for doc in

                       extract_documentation(data, "python", "default")]

        expected = [

            [self.Description(desc='\nModule description.\n\n'

                                   'Some more foobar-like text.\n')],

            [self.Description(desc='\nA nice and neat way of '

                                   'documenting code.\n'),

             self.Parameter(name='radius', desc=' The explosion radius. ')],

            [self.Description(desc='A function that returns 55.')],

            [self.Description(desc='\nDocstring with layouted text.\n\n    '

                                   'layouts inside docs are preserved.'

                                   '\nthis is intended.\n')],

            [self.Description(desc=' Docstring inline with triple quotes.\n'

                                   '    Continues here. ')],

            [self.Description(desc='\nThis is the best docstring ever!\n\n'),

             self.Parameter(name='param1',

                            desc='\n    Very Very Long Parameter '

                                 'description.\n'),

             self.Parameter(name='param2',

                            desc='\n    Short Param description.\n\n'),

             self.ReturnValue(desc=' Long Return Description That Makes No '

                                   'Sense And Will\n         Cut to the Next'

                                   ' Line.\n')]]

        self.assertEqual(parsed_docs, expected)

    def test_python_doxygen(self):

        data = load_testdata("doxygen.py")

        self.assertEqual(parsed_docs, expected)

    def test_python_doxygen(self):

        data = load_testdata("doxygen.py")

        parsed_docs = [doc.parse() for doc in

                       extract_documentation(data, "python", "doxygen")]

        expected = [

            [self.Description(desc=' @package pyexample\n  Documentation for'

                                   ' this module.\n\n  More details.\n')],

            [self.Description(

                desc=' Documentation for a class.\n\n More details.\n')],

            [self.Description(desc=' The constructor.\n')],

            [self.Description(desc=' Documentation for a method.\n'),

             self.Parameter(name='self', desc='The object pointer.\n')],

            [self.Description(desc=' A class variable.\n')],

            [self.Description(desc=' @var _memVar\n  a member variable\n')],

            [self.Description(desc=' This is the best docstring ever!\n\n'),

             self.Parameter(name='param1', desc='Parameter 1\n'),

             self.Parameter(name='param2', desc='Parameter 2\n'),

             self.ReturnValue(desc='Nothing\n')]]

        self.assertEqual(parsed_docs, expected)

class JavaDocumentationCommentTest(DocumentationCommentTest):