fix up doc comments

Author: yaahc

chalk-ir/src/lib.rs

@@ -144,6 +144,10 @@ impl UniverseIndex {
 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub struct StructId<I: Interner>(pub I::DefId);
 
+/// The id of a trait definition; could be used to load the trait datum by
+/// invoking the [`trait_datum`] method.
+///
+/// [`trait_datum`]: ../chalk_solve/trait.RustIrDatabase.html#tymethod.trait_datum
 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub struct TraitId<I: Interner>(pub I::DefId);
 
@@ -153,6 +157,10 @@ pub struct ImplId<I: Interner>(pub I::DefId);
 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub struct ClauseId<I: Interner>(pub I::DefId);
 
+/// The id for the associated type member of a trait. The details of the type
+/// can be found by invoking the [`associated_ty_data`] method.
+///
+/// [`associated_ty_data`]: ../chalk_solve/trait.RustIrDatabase.html#tymethod.associated_ty_data
 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub struct AssocTypeId<I: Interner>(pub I::DefId);
 

chalk-rust-ir/src/lib.rs

@@ -112,10 +112,6 @@ pub struct StructFlags {
 /// [`ImplDatum`]: struct.ImplDatum.html
 /// [`AssociatedTyDatum`]: struct.AssociatedTyDatum.html
 pub struct TraitDatum<I: Interner> {
-    /// The id of this trait; could be used to load the trait datum by invoking
-    /// the [`trait_datum`] method.
-    ///
-    /// [`trait_datum`]: ../chalk_solve/trait.RustIrDatabase.html#tymethod.trait_datum
     pub id: TraitId<I>,
 
     pub binders: Binders<TraitDatumBound<I>>,
@@ -125,13 +121,10 @@ pub struct TraitDatum<I: Interner> {
     /// chalk we add annotations like `#[auto]`.
     pub flags: TraitFlags,
 
-    /// The ids for the associated type members of the trait. The details of
-    /// each type can be found by invoking the [`associated_ty_data`] method.
-    ///
-    /// [`associated_ty_data`]: ../chalk_solve/trait.RustIrDatabase.html#tymethod.associated_ty_data
     pub associated_ty_ids: Vec<AssocTypeId<I>>,
 
-    /// If this is a well-known trait, which one? If `None`, this is a regular, user-defined trait.
+    /// If this is a well-known trait, which one? If `None`, this is a regular,
+    /// user-defined trait.
     pub well_known: Option<WellKnownTrait>,
 }
 

chalk-solve/src/clauses/builtin_traits.rs

@@ -2,6 +2,8 @@ use super::builder::ClauseBuilder;
 use crate::Interner;
 use crate::{TraitRef, WellKnownTrait};
 
+/// For well known traits we have special hard-coded impls, either as an
+/// optimization or to enforce special rules for correctness.
 pub fn add_builtin_program_clauses<I: Interner>(
     well_known: WellKnownTrait,
     _trait_ref: &TraitRef<I>,

chalk-solve/src/lib.rs

@@ -24,7 +24,7 @@ pub trait RustIrDatabase<I: Interner>: Debug {
     /// Returns the datum for the associated type with the given id.
     fn associated_ty_data(&self, ty: AssocTypeId<I>) -> Arc<AssociatedTyDatum<I>>;
 
-    /// Returns the datum for the impl with the given id.
+    /// Returns the datum for the definition with the given id.
     fn trait_datum(&self, trait_id: TraitId<I>) -> Arc<TraitDatum<I>>;
 
     /// Returns the datum for the impl with the given id.