Docs for Rose callback types

diff --git a/src/rose/rose.h b/src/rose/rose.h
index 16cfa435359447bfab0408306da09468de07a2b2..95750363c266b0195ec8a698ec3cabf9fc87eef0 100644 (file)
--- a/src/rose/rose.h
+++ b/src/rose/rose.h
@@ -124,6 +124,4 @@ void roseEodExec(const struct RoseEngine *t, u64a offset,
                  struct hs_scratch *scratch, RoseCallback callback,
                  RoseCallbackSom som_callback);
 
-#define ROSE_CONTINUE_MATCHING_NO_EXHAUST 2
-
 #endif // ROSE_H

diff --git a/src/rose/rose_types.h b/src/rose/rose_types.h
index b70328d258543d9302b9f6f5f70d361f4c4bdf90..9dcef1cef0689e82362b8badb864340a36954373 100644 (file)
--- a/src/rose/rose_types.h
+++ b/src/rose/rose_types.h
@@ -26,6 +26,10 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
+/** \file
+ * \brief Rose runtime types (callbacks, etc).
+ */
+
 #ifndef ROSE_TYPES_H
 #define ROSE_TYPES_H
 
@@ -33,9 +37,34 @@
 
 struct hs_scratch;
 
+/**
+ * \brief Continue without checking for exhaustion.
+ *
+ * \ref RoseCallback return value indicating that execution should continue and
+ * that it is not necessary to check if all reports have been exhausted.
+ */
+#define ROSE_CONTINUE_MATCHING_NO_EXHAUST 2
+
+/**
+ * \brief The type for a Rose callback.
+ *
+ * \return
+ *  - \ref MO_HALT_MATCHING if matching should terminate;
+ *  - \ref MO_CONTINUE_MATCHING if matching should continue;
+ *  - \ref ROSE_CONTINUE_MATCHING_NO_EXHAUST if matching should continue and no
+ *    exhaustion is possible.
+ */
 typedef int (*RoseCallback)(u64a offset, ReportID id,
                             struct hs_scratch *scratch);
 
+/**
+ * \brief The type for a Rose callback which also tracks start of match.
+ *
+ * Behaves just like \ref RoseCallback except that it is provided with both a
+ * start and an end offset.
+ *
+ * \see RoseCallback
+ */
 typedef int (*RoseCallbackSom)(u64a from_offset, u64a to_offset, ReportID id,
                                struct hs_scratch *scratch);