Merge branch 'V7_main'

[modules/kernel.git] / src / KERNEL_PY / kernel / pyunittester.py

diff --git a/src/KERNEL_PY/kernel/pyunittester.py b/src/KERNEL_PY/kernel/pyunittester.py
index 63e7846a1f3f9a7a1af7d10cfed2146fb02919c2..6c8109951920acf38d70e1efb2fdc83909092c9f 100644 (file)
--- a/src/KERNEL_PY/kernel/pyunittester.py
+++ b/src/KERNEL_PY/kernel/pyunittester.py
@@ -1,10 +1,10 @@
 # -*- coding: iso-8859-1 -*-
-# Copyright (C) 2011-2012  CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2011-2014  CEA/DEN, EDF R&D, OPEN CASCADE
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
 # License as published by the Free Software Foundation; either
-# version 2.1 of the License.
+# version 2.1 of the License, or (at your option) any later version.
 #
 # This library is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -18,6 +18,11 @@
 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 #
 
+## \defgroup pyunittester pyunittester
+#  \{ 
+#  \details Simple wrapper of the pyunit framework
+#  \}
+
 import sys
 from salome.kernel import termcolor
 def printfile(filename):
@@ -36,10 +41,12 @@ import unittest
 from unittest import TestCase
 from uiexception import DevelException
 
+## This class is a simple wrapper of the pyunit framework.
+#  \ingroup pyunittester
 class PyUnitTester():
-    '''
+    """
     This class is a simple wrapper of the pyunit framework.
-    '''
+    """
     def __init__(self):
         self.__listTestSuite=[]
         self.setLogFilename("testlog.txt")
@@ -75,6 +82,10 @@ class PyUnitTester():
     def printreport(self):
         printfile(self.__logfilename)
 
+## This can be used to just execute a test function that is
+#  considered as OK simply if no exception is raised (can be test by
+#  an assertTrue).
+#  \ingroup pyunittester
 def execAndConvertExceptionToBoolean(function):
     """
     This can be used to just execute a test function that is
@@ -92,6 +103,8 @@ def execAndConvertExceptionToBoolean(function):
 
 # Simple helper function for most cases where there is only one
 # TestCase classe.
+## Run the test suite provided by the specified TestCase class.
+#  \ingroup pyunittester
 def run(testCaseClass):
     """
     Run the test suite provided by the specified TestCase class.