How to embed a Rust macro variable into documentation?

by

This can be done using a recursive macro:

macro_rules! impl_foo {
    ($name:ident, $sname:expr) => {
        #[doc = "Returns a new `"]
        #[doc = $sname]
        #[doc = "`."]
        pub fn myfoo() -> $name {
            42
        }
    };

    ($name:tt) => {
        impl_foo!($name, stringify!($name));
    };
}

impl_foo!(u32);


fn main() {
    println!("Hello, world!");
}

Which renders as:

Example from rustdoc

More Related Contents:

  1. Is it possible to declare variables procedurally using Rust macros?
  2. Can a Rust macro create new identifiers?
  3. Generating documentation in macros
  4. How to prefix/suffix identifiers within a macro? [duplicate]
  5. How do I match the type of an expression in a Rust macro?
  6. Is there a way to count with macros?
  7. Can macros match against constant arguments instead of literals?
  8. How to allow optional trailing commas in macros?
  9. How to enforce that a type implements a trait at compile time?
  10. What makes Lisp macros so special?
  11. Macros in Swift?
  12. How can I generate unique values in the C preprocessor?
  13. Variadic recursive preprocessor macros – is it possible?
  14. How do I show the value of a #define at compile-time?
  15. How to write macro for Notepad++?
  16. How to auto execute a macro when opening a Powerpoint presentation?
  17. Mathematica: Unevaluated vs Defer vs Hold vs HoldForm vs HoldAllComplete vs etc etc
  18. Can I convert a string to enum without macros in Rust?
  19. Is there a way to get the field names of a struct in a macro?
  20. How do I write an iterator that returns references to itself?
  21. Why do I need to import a trait to use the methods it defines for a type?
  22. Should trait bounds be duplicated in struct and impl?
  23. Convert a String to int?
  24. Implement generic swap macro in C [duplicate]
  25. Why is capitalizing the first letter of a string so convoluted in Rust?
  26. What is the difference between `e1` and `&e2` when used as the for-loop variable?
  27. How do I get the minimum or maximum value of an iterator containing floating point numbers?
  28. Why is “&&” being used in closure arguments?
  29. Why can I iterate over a slice twice, but not a vector?
  30. How do I unwrap an arbitrary number of nested Option types?

Leave a Comment