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.
pull/8879/head
Jason Ish 2 years ago committed by Victor Julien
parent af5a0e11e8
commit c30fff8bcb

@ -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::<AppEvent>(...)
/// 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::<AppEvent>(...)
/// ```
#[inline(always)]
pub unsafe fn get_event_info<T: AppLayerEvent>(
event_name: *const std::os::raw::c_char,

Loading…
Cancel
Save