]> git.lizzy.rs Git - rust.git/commitdiff
rustdoc: add some docs for item types
authorCorey Richardson <corey@octayn.net>
Sun, 16 Mar 2014 23:12:00 +0000 (19:12 -0400)
committerCorey Richardson <corey@octayn.net>
Tue, 25 Mar 2014 19:01:27 +0000 (15:01 -0400)
src/librustdoc/clean.rs

index b0554c21bf92e9200f3b1b983373b5d5f909bde3..bb6302b9fb77f1cc1c69feec0a829394a65866db 100644 (file)
@@ -174,12 +174,18 @@ pub enum ItemEnum {
     StaticItem(Static),
     TraitItem(Trait),
     ImplItem(Impl),
+    /// `use` and `extern crate`
     ViewItemItem(ViewItem),
+    /// A method signature only. Used for required methods in traits (ie,
+    /// non-default-methods).
     TyMethodItem(TyMethod),
+    /// A method with a body.
     MethodItem(Method),
     StructFieldItem(StructField),
     VariantItem(Variant),
+    /// `fn`s from an extern block
     ForeignFunctionItem(Function),
+    /// `static`s from an extern block
     ForeignStaticItem(Static),
     MacroItem(Macro),
 }