Merge pull request #30 from magurotuna/doc_hidden

Add meta word `doc_hidden` to snippet attribute

Author: hatoo

README.md

@@ -79,6 +79,21 @@ fn gcd_list(list: &[u64]) -> u64 {
 #[snippet(prefix = "use std::str::FromStr;")]
 fn foo() {}
 
+// By default, doc comments associated with items will be output with the snippet.
+#[snippet]
+/// This is a document!
+fn documented() {
+    //! Inner document also works.
+}
+
+// If you want it to be hidden, append `doc_hidden` keyword.
+#[snippet(doc_hidden, prefix = "use std::collections::HashMap;")]
+/// This is a doc comment for `bar`.
+/// Since `doc_hidden` is specified, it won't be present in the snippet.
+fn bar() {
+    //! And this is also a doc comment for `bar`, which will be removed.
+}
+
 #[test]
 fn test_gcd() {
     assert_eq!(gcd(57, 3), 3);
@@ -105,6 +120,16 @@ snippet foo
     use std::str::FromStr;
     fn foo() {}
 
+snippet documented
+    /// This is a document!
+    fn documented() {
+        //! Inner document also works.
+    }
+
+snippet bar
+    use std::collections::HashMap;
+    fn bar() {}
+
 snippet gcd
     fn gcd(a: u64, b: u64) -> u64 {
         if b == 0 {
@@ -156,4 +181,4 @@ My snippets [here](https://github.com/hatoo/competitive-rust-snippets.git).
 * Ultisnips
 
 You can specify output format via `-t` option.
-See `cargo snippet -h`.
+See `cargo snippet -h`.