[gtk-doc] mkdb: add tests for basic comment-tags

[Stefan Sauer <stefkost src gnome org>]

commit 66ff54d1a46b227a68285c87a51b806f4e2a3098
Author: Stefan Sauer <ensonic users sf net>
Date:   Thu Nov 22 08:50:32 2018 +0100

    mkdb: add tests for basic comment-tags

 tests/mkdb.py | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
---
diff --git a/tests/mkdb.py b/tests/mkdb.py
index bc4a88c..5e51550 100644
--- a/tests/mkdb.py
+++ b/tests/mkdb.py
@@ -41,6 +41,73 @@ class ScanSourceContent(unittest.TestCase):
              */""".splitlines(keepends=True))
         self.assertEqual({'symbol': 'Description.\n'}, mkdb.SourceSymbolDocs)
 
+    def test_FindsDocCommentWithParam(self):
+        mkdb.ScanSourceContent("""\
+            /**
+             * symbol:
+             * @par: value
+             *
+             * Description.
+             */""".splitlines(keepends=True))
+        self.assertEqual({'symbol': 'Description.\n'}, mkdb.SourceSymbolDocs)
+        self.assertIn('symbol', mkdb.SourceSymbolParams)
+        self.assertEqual({'par': 'value\n'}, mkdb.SourceSymbolParams['symbol'])
+
+    def test_FindsDocCommentWithReturns(self):
+        mkdb.ScanSourceContent("""\
+            /**
+             * symbol:
+             *
+             * Description.
+             *
+             * Returns: result
+             */""".splitlines(keepends=True))
+        # TODO: trim multiple newlines in code
+        self.assertEqual({'symbol': 'Description.\n\n'}, mkdb.SourceSymbolDocs)
+        self.assertIn('symbol', mkdb.SourceSymbolParams)
+        # TODO: trim whitespace in code
+        self.assertEqual({'Returns': ' result\n'}, mkdb.SourceSymbolParams['symbol'])
+
+    def test_FindsDocCommentWithSince(self):
+        mkdb.ScanSourceContent("""\
+            /**
+             * symbol:
+             *
+             * Since: 0.1
+             */""".splitlines(keepends=True))
+        self.assertIn('symbol', mkdb.Since)
+        self.assertEqual('0.1', mkdb.Since['symbol'])
+
+    def test_FindsDocCommentWithDeprecated(self):
+        mkdb.ScanSourceContent("""\
+            /**
+             * symbol:
+             *
+             * Deprecated: use function() instead
+             */""".splitlines(keepends=True))
+        self.assertIn('symbol', mkdb.Deprecated)
+        # TODO: trim whitespace in code
+        self.assertEqual(' use function() instead\n', mkdb.Deprecated['symbol'])
+
+    def test_FindsDocCommentWithStability(self):
+        mkdb.ScanSourceContent("""\
+            /**
+             * symbol:
+             *
+             * Stability: stable
+             */""".splitlines(keepends=True))
+        self.assertIn('symbol', mkdb.StabilityLevel)
+        self.assertEqual('Stable', mkdb.StabilityLevel['symbol'])
+
+    def test_HandlesHTMLEntities(self):
+        mkdb.ScanSourceContent("""\
+            /**
+             * symbol:
+             *
+             * < & >.
+             */""".splitlines(keepends=True))
+        self.assertEqual({'symbol': '&lt; &amp; &gt;.\n'}, mkdb.SourceSymbolDocs)
+
 
 if __name__ == '__main__':
     unittest.main()