From e4338a9d9d0a76029bca376c2bcb499962575e87 Mon Sep 17 00:00:00 2001
From: Max Audron <audron@cocaine.farm>
Date: Thu, 27 Feb 2025 01:03:29 +0100
Subject: extend docs and reorganize files

---
 src/util.rs | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'src/util.rs')

diff --git a/src/util.rs b/src/util.rs
index 98e3521..eb5a595 100644
--- a/src/util.rs
+++ b/src/util.rs
@@ -38,6 +38,17 @@ pub fn insert_bytes(pos: usize, buf: &mut Vec<u8>, input: &mut [u8]) {
     }
 }
 
+/// Easily create HashMaps for tests
+///
+/// ```rust
+/// use libquassel::{map, s};
+/// use libquassel::primitive::{Variant, VariantMap};
+///
+/// let example: VariantMap = map! {
+///    s!("id") => Variant::VariantList(vec![Variant::i32(1)]),
+///    s!("name") => Variant::StringList(vec![s!("testrule")]),
+///};
+/// ```
 #[macro_export]
 macro_rules! map {
     // map-like
@@ -50,6 +61,7 @@ macro_rules! map {
     };
 }
 
+/// Shorthand to make an owned string: `s!("example text")`
 #[macro_export]
 macro_rules! s {
     ($values:expr) => {
@@ -57,6 +69,7 @@ macro_rules! s {
     };
 }
 
+/// Remove the first entry in a SyncMessage
 #[macro_export]
 macro_rules! get_param {
     ( $msg:expr ) => {
-- 
cgit v1.2.3