]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
rust/doc: fix doc compile issues
authorVictor Julien <vjulien@oisf.net>
Fri, 12 May 2023 05:04:17 +0000 (07:04 +0200)
committerVictor Julien <vjulien@oisf.net>
Fri, 12 May 2023 05:04:17 +0000 (07:04 +0200)
rust/src/applayer.rs

index 9dfde28491f686a294b5d2663c734d7342ebede3..3f33c5f9d861832b28e282682c73ed87b6a052f9 100644 (file)
@@ -588,19 +588,20 @@ pub trait AppLayerEvent {
     ) -> i8;
 }
 
+//
+// Normally usage of this function will be generated by
+// derive(AppLayerEvent), for example:
+//
+// #[derive(AppLayerEvent)]
+// enum AppEvent {
+//     EventOne,
+//     EventTwo,
+// }
+//
+// get_event_info::<AppEvent>(...)
+
 /// Generic `get_info_info` implementation for enums implementing
 /// AppLayerEvent.
-///
-/// Normally usage of this function will be generated by
-/// derive(AppLayerEvent), for example:
-///
-/// #[derive(AppLayerEvent)]
-/// enum AppEvent {
-///     EventOne,
-///     EventTwo,
-/// }
-///
-/// get_event_info::<AppEvent>(...)
 #[inline(always)]
 pub unsafe fn get_event_info<T: AppLayerEvent>(
     event_name: *const std::os::raw::c_char,