EXSWHTEC-224 - Test cases ID clean up and documentation for Event Management (#71)

- Test cases ID clean up and documentation for Event Management [ROCm/hip-tests commit: 3969e4a320]
2023-06-28 06:15:15 +02:00
parent a8f65237eb
commit b2829b49de
12 changed files with 491 additions and 54 deletions
@@ -19,13 +19,28 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 */
-/*
-Testcase Scenarios :
-Unit_hipEventCreateWithFlags_Positive - Test simple event creation with hipEventCreateWithFlags api for each flag
-*/

 #include <hip_test_common.hh>

+/**
+ * @addtogroup hipEventCreateWithFlags hipEventCreateWithFlags
+ * @{
+ * @ingroup EventTest
+ * `hipEventCreateWithFlags(hipEvent_t* event, unsigned flags)` -
+ * Create an event with the specified flags to control event behaviour.
+ */
+
+/**
+ * Test Description
+ * ------------------------
+ *  - Successfully create an event with all defined device flags.
+ * Test source
+ * ------------------------
+ *  - unit/event/hipEventCreateWithFlags.cc
+ * Test requirements
+ * ------------------------
+ *  - HIP_VERSION >= 5.2
+ */
 TEST_CASE("Unit_hipEventCreateWithFlags_Positive") {

 #if HT_AMD