better documentation
Rust/sat-rs/pipeline/head Build queued... Details

This commit is contained in:
Robin Müller 2024-02-12 18:10:33 +01:00
parent f14a85cb84
commit e9e5c999ec
2 changed files with 7 additions and 0 deletions

View File

@ -1,6 +1,12 @@
use quote::{format_ident, quote, ToTokens};
use syn::{parse_macro_input, ItemConst, LitStr};
/// This macro can be used to automatically generate introspection information for return codes.
///
/// For example, it can be applied to types like the [satrs_shared::res_code::ResultU16] type
/// to automatically generate [satrs_mib::res_code::ResultU16Info] instances. These instances
/// can then be used for tasks like generating CSVs or YAML files with the list of all result
/// codes. This information is valuable for both operators and developers.
#[proc_macro_attribute]
pub fn resultcode(
args: proc_macro::TokenStream,

View File

@ -73,6 +73,7 @@ pub mod stdmod {
Ok(())
}
/// This function exports a slice of result code information objects to a CSV file.
pub fn write_resultcodes_to_csv(
writer_builder: csv::WriterBuilder,
results: &[ResultU16Info],