Expand comment reading

Expand the comment attribute reading to Namespace and Enumeration
objects.  Add tests for each of those objects.

Author: josephsnyder

pygccxml/parser/scanner.py

@@ -416,14 +416,19 @@ def __read_namespace(self, attrs):
             # that is almost true: gcc mangale name using top file name.
             # almost all files has '.' in name
             ns_name = ''
-        return self.__decl_factory.create_namespace(name=ns_name)
+        decl = self.__decl_factory.create_namespace(name=ns_name)
+        if attrs.get(XML_AN_COMMENT):
+            decl.comment = attrs.get(XML_AN_COMMENT)
+        return decl
 
     def __read_enumeration(self, attrs):
         enum_name = attrs.get(XML_AN_NAME, '')
         if '$_' in enum_name or '._' in enum_name:
             # it means that this is unnamed enum. in c++ enum{ x };
             enum_name = ''
         decl = self.__decl_factory.create_enumeration(name=enum_name)
+        if attrs.get(XML_AN_COMMENT):
+            decl.comment = attrs.get(XML_AN_COMMENT)
         self.__read_byte_size(decl, attrs)
         self.__read_byte_align(decl, attrs)
         self.__enums.append(decl)

unittests/data/test_comments.hpp

@@ -3,21 +3,38 @@
 // Distributed under the Boost Software License, Version 1.0.
 // See http://www.boost.org/LICENSE_1_0.txt
 
-/** class comment */
-class test
-{
-public:
-  // Non-doc comment before.
-  /** doc comment */
-  // Non-doc comment after.
-  test();
+//! Namespace Comment
+//! Across multiple lines
+namespace comment {
 
-  /// cxx comment
-  /// with multiple lines
-  int hello();
+    /** class comment */
+    class test
+    {
+    public:
+      // Non-doc comment before.
+      /** doc comment */
+      // Non-doc comment after.
+      test();
 
-  //! mutable field comment
-  int val1 = 0;
-  /// bit field comment
-  double val2=2;
-};
+      /// cxx comment
+      /// with multiple lines
+      int hello();
+
+      //! mutable field comment
+      int val1 = 0;
+      /// bit field comment
+      double val2=2;
+
+      /// inside class enum comment
+      enum test_enum {
+        One = 1,
+        Two = 2
+      };
+    };
+
+    /// Outside Class enum comment
+    enum com_enum {
+      One = 1,
+      Two = 2
+    };
+}

unittests/test_comments.py

@@ -37,10 +37,27 @@ def test(self):
         if self.config.castxml_epic_version != 1:
             # Run this test only with castxml epic version == 1
             return
-        tclass = self.global_ns.class_("test")
+
+        tnamespace = self.global_ns.namespace("comment")
+
+        self.assertIn("comment", dir(tnamespace))
+        self.assertEqual(["//! Namespace Comment", "//! Across multiple lines"],
+                         tnamespace.comment.text)
+
+        tenumeration = tnamespace.enumeration("com_enum")
+        self.assertIn("comment", dir(tenumeration))
+        self.assertEqual(['/// Outside Class enum comment'],
+                         tenumeration.comment.text)
+
+        tclass = tnamespace.class_("test")
         self.assertIn("comment", dir(tclass))
         self.assertEqual(["/** class comment */"], tclass.comment.text)
 
+        tcls_enumeration = tclass.enumeration("test_enum")
+        self.assertIn("comment", dir(tcls_enumeration))
+        self.assertEqual(['/// inside class enum comment'],
+                         tcls_enumeration.comment.text)
+
         tmethod = tclass.member_functions()[0]
 
         self.assertIn("comment", dir(tmethod))