Skip to content

Commit 9ad14fc

Browse files
committed
Added Doxygent compliant code documentation for unit tests
1 parent 1bd4e4a commit 9ad14fc

File tree

5 files changed

+14
-0
lines changed

5 files changed

+14
-0
lines changed

test/__init__.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,9 @@
1414
See the License for the specific language governing permissions and
1515
limitations under the License.
1616
"""
17+
18+
"""! @package mbed-ls-test
19+
20+
Unit tests for mbed-ls package
21+
22+
"""

test/basic.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323

2424

2525
class BasicTestCase(unittest.TestCase):
26+
""" Basic test cases checking trivial asserts
27+
"""
2628

2729
def setUp(self):
2830
pass

test/detect_os.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@
2929

3030

3131
class DetectOSTestCase(unittest.TestCase):
32+
""" Test cases for host OS related functionality. Helpful during porting
33+
"""
3234

3335
def setUp(self):
3436
pass

test/listing.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@
2626

2727

2828
class MbedListingestCase(unittest.TestCase):
29+
""" UNit tests for mbed-ls ability to list connected devices
30+
"""
2931

3032
def setUp(self):
3133
self.mbeds = create()

test/mbed_htm.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@
3030

3131

3232
class ParseMbedHTMTestCase(unittest.TestCase):
33+
""" Unit tests checking HTML parsing code for 'mbed.htm' files
34+
"""
3335

3436
def setUp(self):
3537
self.mbeds = create()

0 commit comments

Comments
 (0)