tree: 848617f4ae1b4754cb20e589ad77fbc105f8b7d1 [path history] [tgz]
  1. src/
  2. .cargo-checksum.json
  3. build.rs
  4. Cargo.toml
  5. LICENSE
  6. README.md
vendor/doc-comment-0.3.3/README.md

doc-comment

Write doc comments from macros.

Usage example

// Of course, we need to import the `doc_comment` macro:
#[macro_use]
extern crate doc_comment;

// If you want to test examples in your README file.
doctest!("../README.md");

// If you want to test your README file ONLY on "cargo test":
#[cfg(doctest)]
doctest!("../README.md");

// If you want to document an item:
doc_comment!(concat!("fooo", "or not foo"), pub struct Foo {});

For more information, take a look at the documentation.