about summary refs log tree commit diff
diff options
context:
space:
mode:
authorCorey Richardson <corey@octayn.net>2014-03-16 19:12:00 -0400
committerCorey Richardson <corey@octayn.net>2014-03-25 15:01:27 -0400
commite88387a94709b3bf86c4abf39477be9ffa26c7e8 (patch)
treecfc01a7c60d966f48bd1a5c7c20e88b479bb5a2f
parent6f6b099f5daf6283a19ee2cccc4b1458890486ec (diff)
downloadrust-e88387a94709b3bf86c4abf39477be9ffa26c7e8.tar.gz
rust-e88387a94709b3bf86c4abf39477be9ffa26c7e8.zip
rustdoc: add some docs for item types
-rw-r--r--src/librustdoc/clean.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/librustdoc/clean.rs b/src/librustdoc/clean.rs
index b0554c21bf9..bb6302b9fb7 100644
--- a/src/librustdoc/clean.rs
+++ b/src/librustdoc/clean.rs
@@ -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),
 }