Require documentation on cretonne public items.

2016-10-26 18:41:39 -07:00
parent e2418c6ec9
commit 80823b5fc4
16 changed files with 124 additions and 44 deletions
--- a/lib/cretonne/src/dominator_tree.rs
+++ b/lib/cretonne/src/dominator_tree.rs
@@ -1,10 +1,11 @@
-/// ! A Dominator Tree represented as mappings of Ebbs to their immediate dominator.
+//! A Dominator Tree represented as mappings of Ebbs to their immediate dominator.

 use cfg::*;
 use ir::Ebb;
 use ir::entities::NO_INST;
 use entity_map::EntityMap;

+/// The dominator tree for a single function.
 pub struct DominatorTree {
    data: EntityMap<Ebb, Option<BasicBlock>>,
 }