Documentation

2 files changed, 59 insertions, 2 deletions

diff --git a/include/junitxml.h b/include/junitxml.h
index d5e7708..430b627 100644
--- a/include/junitxml.h
+++ b/include/junitxml.h
@@ -28,20 +28,77 @@ struct JUNIT_Testcase {
 };
 
 struct JUNIT_Testsuite {
+    //< Test suite name
     char *name;
+    //< Total number of test terminated due to an error
     int errors;
+    //< Total number of failed tests
     int failures;
+    //< Total number of skipped tests
     int skipped;
+    //< Total number of tests
     int tests;
+    //< Total duration in fractional seconds
     float time;
+    //< Timestamp
     char *timestamp;
+    //< Test runner host name
     char *hostname;
+    //< Array of test cases
     struct JUNIT_Testcase **testcase;
+    //< Total number of test cases in use
     size_t _tc_inuse;
+    //< Total number of test cases allocated
     size_t _tc_alloc;
 };
 
+/**
+ * Extract information from a junit XML file
+ *
+ * ~~~{.c}
+ * struct JUNIT_Testsuite *testsuite;
+ * const char *filename = "/path/to/result.xml";
+ *
+ * testsuite = junitxml_testsuite_read(filename);
+ * if (testsuite) {
+ *     // Did any test cases fail?
+ *     if (testsuite->failures) {
+ *         printf("Test suite '%s' has %d failure(s)\n", testsuite->name, testsuite->failures
+ *         // Scan test cases for failure data
+ *         for (size_t i = 0; i < testsuite->_tc_inuse; i++) {
+ *             // Check result state (one of)
+ *             //   JUNIT_RESULT_STATE_FAILURE
+ *             //   JUNIT_RESULT_STATE_SKIPPED
+ *             struct JUNIT_Testcase testcase = testsuite->testcase[i];
+ *             if (testcase->tc_result_state_type) {
+ *                 if (testcase->tc_result_state_type == JUNIT_RESULT_STATE_FAILURE) {
+ *                     // Display information from failed test case
+ *                     printf("[FAILED] %s::%s\nOutput:\n%s\n",
+ *                         testcase->classname,
+ *                         testcase->name,
+ *                         testcase->result_state.failure->message);
+ *                 }
+ *             }
+ *         }
+ *     }
+ *     // Release test suite resources
+ *     junitxml_testsuite_free(&testsuite);
+ * } else {
+ *     // handle error
+ * }
+ *
+ *
+ * ~~~
+ *
+ * @param filename path to junit XML file
+ * @return pointer to JUNIT_Testsuite
+ */
 struct JUNIT_Testsuite *junitxml_testsuite_read(const char *filename);
+
+/**
+ * Free memory allocated by junitxml_testsuite_read
+ * @param testsuite pointer to JUNIT_Testsuite
+ */
 void junitxml_testsuite_free(struct JUNIT_Testsuite **testsuite);
 
 #endif //OMC_JUNITXML_H
diff --git a/src/relocation.c b/src/relocation.c
index 2f29d69..586d1ba 100644
--- a/src/relocation.c
+++ b/src/relocation.c
@@ -8,7 +8,7 @@
  * Replace all occurrences of `target` with `replacement` in `original`
  *
  * ~~~{.c}
- * char *str = (char *)calloc(100, sizeof(char));
+ * char *str = calloc(100, sizeof(char));
  * strcpy(str, "This are a test.");
  * if (replace_text(str, "are", "is")) {
  *     fprintf(stderr, "string replacement failed\n");
@@ -91,7 +91,7 @@ int replace_text(char *original, const char *target, const char *replacement, un
  * Replace `target` with `replacement` in `filename`
  *
  * ~~~{.c}
- * if (file_replace_text("/path/to/file.txt, "are", "is")) {
+ * if (file_replace_text("/path/to/file.txt", "are", "is")) {
  *     fprintf(stderr, "failed to replace strings in file\n");
  *     exit(1);
  * }