Require module documentation with missing_doc

Closes #9824

Author: alexcrichton

src/libextra/crypto/digest.rs

@@ -8,6 +8,8 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+//! Common functionality related to cryptographic digest functions
+
 use std::vec;
 
 use hex::ToHex;

src/libextra/crypto/md5.rs

@@ -8,6 +8,8 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+#[allow(missing_doc)];
+
 use std::iter::range_step;
 
 use cryptoutil::{write_u32_le, read_u32v_le, FixedBuffer, FixedBuffer64, StandardPadding};

src/libextra/crypto/sha2.rs

@@ -8,6 +8,8 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+#[allow(missing_doc)];
+
 use std::iter::range_step;
 
 use cryptoutil::{write_u64_be, write_u32_be, read_u64v_be, read_u32v_be, add_bytes_to_bits,

src/libextra/enum_set.rs

@@ -8,6 +8,11 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+//! A structure for holding a set of enum variants
+//!
+//! This module defines a container which uses an efficient bit mask
+//! representation to hold C-like enum variants.
+
 #[deriving(Clone, Eq, IterBytes, ToStr)]
 /// A specialized Set implementation to use enum types.
 pub struct EnumSet<E> {

src/libextra/io_util.rs

@@ -8,6 +8,8 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+#[allow(missing_doc)];
+
 use std::io::{Reader, BytesReader};
 use std::io;
 use std::cast;

src/libextra/md4.rs

@@ -8,6 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+#[allow(missing_doc)];
 
 use std::vec;
 

src/libextra/rl.rs

@@ -8,12 +8,14 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+//! Bindings for the ability to read lines of input from the console
+
 use std::c_str::ToCStr;
 use std::libc::{c_char, c_int};
 use std::{local_data, str, rt};
 use std::unstable::finally::Finally;
 
-pub mod rustrt {
+mod rustrt {
     use std::libc::{c_char, c_int};
 
     externfn!(fn linenoise(prompt: *c_char) -> *c_char)

src/libextra/stats.rs

@@ -8,6 +8,8 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+#[allow(missing_doc)];
+
 use sort;
 use std::cmp;
 use std::hashmap;

src/libextra/sync.rs

@@ -8,6 +8,8 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+#[allow(missing_doc)];
+
 /**
  * The concurrency primitives you know and love.
  *

src/libextra/terminfo/terminfo.rs

@@ -8,6 +8,8 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+#[allow(missing_doc)];
+
 use std::hashmap::HashMap;
 
 /// A parsed terminfo entry.

src/librustc/middle/lint.rs

@@ -955,6 +955,11 @@ impl Visitor<()> for MissingDocLintVisitor {
                                  ~"missing documentation for a function");
             }
 
+            ast::item_mod(*) if it.vis == ast::public => {
+                self.check_attrs(it.attrs, it.id, it.span,
+                                 ~"missing documentation for a module");
+            }
+
             ast::item_enum(ref edef, _) if it.vis == ast::public => {
                 self.check_attrs(it.attrs, it.id, it.span,
                                  ~"missing documentation for an enum");

src/libstd/at_vec.rs

@@ -135,6 +135,7 @@ impl<T> Clone for @[T] {
 }
 
 #[cfg(not(test))]
+#[allow(missing_doc)]
 pub mod traits {
     use at_vec::append;
     use clone::Clone;
@@ -152,6 +153,7 @@ pub mod traits {
 #[cfg(test)]
 pub mod traits {}
 
+#[allow(missing_doc)]
 pub mod raw {
     use at_vec::capacity;
     use cast;

src/libstd/fmt/parse.rs

@@ -8,6 +8,12 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+//! Parsing of format strings
+//!
+//! These structures are used when parsing format strings for the compiler.
+//! Parsing does not currently happen at runtime (structures of std::fmt::rt are
+//! generated instead).
+
 use prelude::*;
 
 use char;

src/libstd/select.rs

@@ -8,6 +8,8 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+#[allow(missing_doc)];
+
 use cell::Cell;
 use comm;
 use container::Container;

src/libstd/str.rs

@@ -1253,6 +1253,7 @@ Section: Trait implementations
 */
 
 #[cfg(not(test))]
+#[allow(missing_doc)]
 pub mod traits {
     use ops::Add;
     use cmp::{TotalOrd, Ordering, Less, Equal, Greater, Eq, Ord, Equiv, TotalEq};

src/libstd/vec.rs

@@ -603,6 +603,7 @@ impl<'self, T> RandomAccessIterator<&'self [T]> for ChunkIter<'self, T> {
 // Equality
 
 #[cfg(not(test))]
+#[allow(missing_doc)]
 pub mod traits {
     use super::*;
 

src/libsyntax/ext/expand.rs

@@ -991,6 +991,7 @@ pub fn std_macros() -> @str {
             pub mod $c {
                 #[allow(unused_imports)];
                 #[allow(non_uppercase_statics)];
+                #[allow(missing_doc)];
 
                 use super::*;
 

src/test/compile-fail/lint-missing-doc.rs

@@ -29,6 +29,9 @@ pub struct PubFoo2 {
     c: int,
 }
 
+mod module_no_dox {}
+pub mod pub_module_no_dox {} //~ ERROR: missing documentation
+
 /// dox
 pub fn foo() {}
 pub fn foo2() {} //~ ERROR: missing documentation