From c30fff8bcb0d58bc7cc0cd95e09c4c63376dfefb Mon Sep 17 00:00:00 2001 From: Jason Ish Date: Fri, 12 May 2023 08:59:54 -0600 Subject: [PATCH] rust/doc: restore comment with code example, but ignore Use backticks for proper markdown processing. As Rust code in backticks is compiled, and this is a non-complete example, tag the code sample to be ignored. --- rust/src/applayer.rs | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/rust/src/applayer.rs b/rust/src/applayer.rs index 3f33c5f9d8..75e507de59 100644 --- a/rust/src/applayer.rs +++ b/rust/src/applayer.rs @@ -588,20 +588,21 @@ 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::(...) - /// Generic `get_info_info` implementation for enums implementing /// AppLayerEvent. +/// +/// Normally usage of this function will be generated by +/// derive(AppLayerEvent), for example: +/// +/// ```rust,ignore +/// #[derive(AppLayerEvent)] +/// enum AppEvent { +/// EventOne, +/// EventTwo, +/// } +/// +/// get_event_info::(...) +/// ``` #[inline(always)] pub unsafe fn get_event_info( event_name: *const std::os::raw::c_char,