Generate documentation for all public items in xml5ever (#647)

Signed-off-by: Simon Wülker <[email protected]>

Author: simonwuelker

xml5ever/src/tokenizer/states.rs

@@ -12,19 +12,19 @@
 //! This is public for use by the tokenizer tests.  Other library
 //! users should not have to care about this.
 
-pub use self::AttrValueKind::*;
-pub use self::DoctypeKind::*;
-pub use self::XmlState::*;
+#![allow(missing_docs)] // FIXME
+
+pub use AttrValueKind::*;
+pub use DoctypeKind::*;
+pub use XmlState::*;
 
 #[derive(PartialEq, Eq, PartialOrd, Ord, Copy, Clone, Hash, Debug)]
-#[doc(hidden)]
 pub enum DoctypeKind {
     Public,
     System,
 }
 
 #[derive(PartialEq, Eq, PartialOrd, Ord, Copy, Clone, Hash, Debug)]
-#[doc(hidden)]
 pub enum XmlState {
     Data,
     TagState,
@@ -73,7 +73,6 @@ pub enum XmlState {
 }
 
 #[derive(PartialEq, Eq, PartialOrd, Ord, Copy, Clone, Hash, Debug)]
-#[doc(hidden)]
 pub enum AttrValueKind {
     Unquoted,
     SingleQuoted,

xml5ever/src/tree_builder/mod.rs

@@ -46,14 +46,12 @@ impl NamespaceMapStack {
         self.0.push(map);
     }
 
-    #[doc(hidden)]
-    pub fn pop(&mut self) {
+    fn pop(&mut self) {
         self.0.pop();
     }
 }
 
-#[doc(hidden)]
-pub struct NamespaceMap {
+pub(crate) struct NamespaceMap {
     // Map that maps prefixes to URI.
     //
     // Key denotes namespace prefix, and value denotes
@@ -76,8 +74,7 @@ impl Debug for NamespaceMap {
 
 impl NamespaceMap {
     // Returns an empty namespace.
-    #[doc(hidden)]
-    pub fn empty() -> NamespaceMap {
+    pub(crate) fn empty() -> NamespaceMap {
         NamespaceMap {
             scope: BTreeMap::new(),
         }
@@ -95,18 +92,15 @@ impl NamespaceMap {
         }
     }
 
-    #[doc(hidden)]
-    pub fn get(&self, prefix: &Option<Prefix>) -> Option<&Option<Namespace>> {
+    pub(crate) fn get(&self, prefix: &Option<Prefix>) -> Option<&Option<Namespace>> {
         self.scope.get(prefix)
     }
 
-    #[doc(hidden)]
-    pub fn get_scope_iter(&self) -> Iter<'_, Option<Prefix>, Option<Namespace>> {
+    pub(crate) fn get_scope_iter(&self) -> Iter<'_, Option<Prefix>, Option<Namespace>> {
         self.scope.iter()
     }
 
-    #[doc(hidden)]
-    pub fn insert(&mut self, name: &QualName) {
+    pub(crate) fn insert(&mut self, name: &QualName) {
         let prefix = name.prefix.as_ref().cloned();
         let namespace = Some(Namespace::from(&*name.ns));
         self.scope.insert(prefix, namespace);
@@ -440,7 +434,6 @@ fn current_node<Handle>(open_elems: &[Handle]) -> &Handle {
     open_elems.last().expect("no current element")
 }
 
-#[doc(hidden)]
 impl<Handle, Sink> XmlTreeBuilder<Handle, Sink>
 where
     Handle: Clone,
@@ -609,7 +602,6 @@ fn any_not_whitespace(x: &StrTendril) -> bool {
         .all(|b| matches!(b, b'\t' | b'\r' | b'\n' | b'\x0C' | b' '))
 }
 
-#[doc(hidden)]
 impl<Handle, Sink> XmlTreeBuilder<Handle, Sink>
 where
     Handle: Clone,