diff --git a/satrs-mib/codegen/src/lib.rs b/satrs-mib/codegen/src/lib.rs index 906bc1a..118f59a 100644 --- a/satrs-mib/codegen/src/lib.rs +++ b/satrs-mib/codegen/src/lib.rs @@ -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, diff --git a/satrs-mib/src/res_code.rs b/satrs-mib/src/res_code.rs index c7d0656..0e50516 100644 --- a/satrs-mib/src/res_code.rs +++ b/satrs-mib/src/res_code.rs @@ -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],