Add more documentation about Module and Backend.

2018-09-05 15:19:14 -07:00
parent 437a657899
commit f3c46ad2a2
4 changed files with 28 additions and 2 deletions
--- a/lib/faerie/src/backend.rs
+++ b/lib/faerie/src/backend.rs
@@ -85,6 +85,8 @@ impl FaerieBuilder {
 }

 /// A `FaerieBackend` implements `Backend` and emits ".o" files using the `faerie` library.
+///
+/// See the `FaerieBuilder` for a convenient way to construct `FaerieBackend` instances.
 pub struct FaerieBackend {
    isa: Box<TargetIsa>,
    artifact: faerie::Artifact,