Mercurial > crates > nonstick

comparison src/_doc.rs @ 174:9e4ce1631bd3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Dramatically expand documentation.
author Paul Fisher <paul@pfish.zone>
date Tue, 29 Jul 2025 18:58:27 -0400
parents e27c5c667a5a
children
comparison
equal deleted inserted replaced
173:46e8ce5cd5d1 174:9e4ce1631bd3
141 /// 141 ///
142 /// # Examples 142 /// # Examples
143 /// 143 ///
144 /// ```ignore 144 /// ```ignore
145 /// # use nonstick::_doc::mansun; 145 /// # use nonstick::_doc::mansun;
146 /// // Both of these formulations create a link named `manbsd`. 146 /// // Both of these formulations create a link named `mansun`.
147 /// #[doc = mansun!(3pam fn_name)] 147 /// #[doc = mansun!(3pam fn_name)]
148 /// #[doc = mansun!(5 "a.out" "synopsis")] 148 /// #[doc = mansun!(5 "a.out" "synopsis")]
149 /// // This one creates a link named `link_name`. 149 /// // This one creates a link named `link_name`.
150 /// #[doc = mansun!(link_name: 1 alias "examples")] 150 /// #[doc = mansun!(link_name: 1 alias "examples")]
151 /// # fn do_whatever() {} 151 /// # fn do_whatever() {}
152 /// ``` 152 /// ```
153 macro_rules! mansun { 153 macro_rules! mansun {
154 ($n:literal $func:ident $($anchor:literal)?) => { 154 ($n:literal $func:ident $($anchor:literal)?) => {
155 $crate::_doc::mansun!(mansun: [$n ""] $func $($anchor)?) 155 $crate::_doc::mansun!(mansun: [$n ""] $func $($anchor)?)
156 }; 156 };
157 ($n:literal $func:literal $($anchor:literal)?) => {
158 $crate::_doc::mansun!(mansun: [$n ""] $func $($anchor)?)
159 };
157 ([$n:literal $sect:literal] $func:ident $($anchor:literal)?) => { 160 ([$n:literal $sect:literal] $func:ident $($anchor:literal)?) => {
158 $crate::_doc::mansun!(mansun: [$n $sect] $func $($anchor)?) 161 $crate::_doc::mansun!(mansun: [$n $sect] $func $($anchor)?)
159 }; 162 };
160 ($name:ident: $n:literal $func:ident $($anchor:literal)?) => { 163 ($name:ident: $n:literal $func:ident $($anchor:literal)?) => {
161 $crate::_doc::mansun!($name: [$n ""] $func $($anchor)?) 164 $crate::_doc::mansun!($name: [$n ""] $func $($anchor)?)
165 };
166 ($name:ident: $n:literal $func:literal $($anchor:literal)?) => {
167 $crate::_doc::mansun!($name: [$n ""] ($func) $($anchor)?)
162 }; 168 };
163 ($name:ident: [$n:literal $sect:literal] $func:ident $($anchor:literal)?) => { 169 ($name:ident: [$n:literal $sect:literal] $func:ident $($anchor:literal)?) => {
164 $crate::_doc::mansun!($name: [$n $sect] (stringify!($func)) $($anchor)?) 170 $crate::_doc::mansun!($name: [$n $sect] (stringify!($func)) $($anchor)?)
165 }; 171 };
166 ($name:ident: [$n:literal $sect:literal] ($func:expr) $($anchor:literal)?) => { 172 ($name:ident: [$n:literal $sect:literal] ($func:expr) $($anchor:literal)?) => {