Added Doxygent compliant code documentation for unit tests

ARMmbed · Jun 30, 2015 · 9ad14fc · 9ad14fc
1 parent 1bd4e4a
commit 9ad14fc
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 0 deletions.
diff --git a/test/__init__.py b/test/__init__.py
@@ -14,3 +14,9 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 """
+
+"""! @package mbed-ls-test
+
+Unit tests for mbed-ls package
+
+"""
diff --git a/test/basic.py b/test/basic.py
@@ -23,6 +23,8 @@
 
 
 class BasicTestCase(unittest.TestCase):
+    """ Basic test cases checking trivial asserts
+    """
 
     def setUp(self):
         pass

diff --git a/test/detect_os.py b/test/detect_os.py
@@ -29,6 +29,8 @@
 
 
 class DetectOSTestCase(unittest.TestCase):
+    """ Test cases for host OS related functionality. Helpful during porting
+    """
 
     def setUp(self):
         pass

diff --git a/test/listing.py b/test/listing.py
@@ -26,6 +26,8 @@
 
 
 class MbedListingestCase(unittest.TestCase):
+    """ UNit tests for mbed-ls ability to list connected devices
+    """
 
     def setUp(self):
         self.mbeds = create()

diff --git a/test/mbed_htm.py b/test/mbed_htm.py
@@ -30,6 +30,8 @@
 
 
 class ParseMbedHTMTestCase(unittest.TestCase):
+    """ Unit tests checking HTML parsing code for 'mbed.htm' files
+    """
 
     def setUp(self):
         self.mbeds = create()
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,6 +23,8 @@ @@
     class BasicTestCase(unittest.TestCase):
+        """ Basic test cases checking trivial asserts
+        """
         def setUp(self):
             pass
@@ Expand Down @@