Fixed most documentation

Author: gammelalf

rorm-db

@@ -74,8 +74,8 @@ pub enum CollectionOperator {
 ///
 /// ## Disadvantage:
 /// - All conditions have to be of the same type.
-///     This can be mitigated by erasing their type using [Condition::boxed].
-///     In this case use [`BoxedCondition<'a>`](super::BoxedCondition) for the generic variable `T`.
+///     This can be mitigated by erasing their type using [`Condition::boxed`].
+///     In this case use [`Box<dyn Condition>`] for the generic variable `T`.
 #[derive(Clone)]
 pub struct DynamicCollection<T> {
     /// Operator used for joining, i.e. `and` or `or`

src/conditions/collections.rs

@@ -1,6 +1,6 @@
 //! A high-level generic condition tree
 //!
-//! It is basically a generic version of the [`rorm_db::Condition`](conditional::Condition) tree.
+//! It is basically a generic version of the [`rorm_sql::Condition`](rorm_db::sql::conditional::Condition) tree.
 
 use std::borrow::Cow;
 use std::sync::Arc;
@@ -155,7 +155,7 @@ pub enum Value<'a> {
     BitVec(crate::fields::types::postgres_only::BitCow<'a>),
 }
 impl Value<'_> {
-    /// Convert into an [`sql::Value`](value::Value) instead of an [`sql::Condition`](conditional::Condition) directly.
+    /// Convert into an [`sql::Value`](value::Value) instead of an [`sql::Condition`](rorm_db::sql::conditional::Condition) directly.
     pub fn as_sql(&self) -> value::Value {
         match self {
             Value::Null(null_type) => value::Value::Null(*null_type),

src/conditions/mod.rs

@@ -169,7 +169,7 @@ where
     }
 }
 
-/// [`Decoder`] returned by [`DecoderExt::decoder`]
+/// [`Decoder`] returned by [`DecoderExt::optional`]
 pub struct Optional<D> {
     decoder: D,
 }

src/crud/decoder.rs

@@ -4,13 +4,7 @@
 //! This means for every crud query ([INSERT](insert), [SELECT](query), [UPDATE](update), [DELETE](delete)) there exists a builder struct
 //! whose methods allow you to set the various parameters.
 //!
-//! To begin a builder it is recommended to use the associated macros [`insert!`], [`query!`], [`update!`] and [`delete!`].
-//! The hide some of the generic details and may run some compile time checks.
-//!
-//! [`insert!`]: macro@crate::insert
-//! [`query!`]: macro@crate::query
-//! [`update!`]: macro@crate::update
-//! [`delete!`]: macro@crate::delete
+//! To begin a builder use their associated functions [`insert`], [`query`], [`update`] and [`delete`].
 pub mod builder;
 pub mod decoder;
 pub mod delete;

src/crud/mod.rs

@@ -96,7 +96,7 @@ where
 ///
 ///     The executor to query with.
 ///
-/// - `M`: [`Model`](Model)
+/// - `M`: [`Model`]
 ///
 ///     The model from whose table to update rows.
 ///

src/crud/update.rs

@@ -11,7 +11,7 @@ use crate::fields::traits::{Array, FieldType};
 
 /// Marker for [`FieldProxy::count`]
 ///
-/// This is implemented for every [`SingleColumnFieldType`]
+/// This is implemented for every [`SingleColumnFieldType`](crate::internal::field::SingleColumnField)
 pub trait FieldCount: FieldType {}
 impl<T> FieldCount for T where T: FieldType<Columns = Array<1>> {}
 

src/fields/traits/aggregate.rs

@@ -4,11 +4,11 @@
 //! Also contains more traits corresponding to other sql comparison operators.
 //!
 //! ## Using
-//! Don't call the traits' methods directly. Instead use the corresponding method on [`FieldAccess`].
+//! Don't call the traits' methods directly. Instead use the corresponding method on [`FieldProxy`].
 //! Otherwise the assumptions an implementation is allowed to make, might be violated.
 //!
 //! ## Implementing
-//! - Each method takes an [`FieldAccess`]; an implementation may assume that the access' field's type
+//! - Each method takes an [`FieldProxy`]; an implementation may assume that the access' field's type
 //!   matches the type the trait is implemented on. This isn't enforced using trait bounds (yet?) to reduce complexity.
 
 use super::FieldType;

src/fields/traits/cmp.rs

@@ -55,7 +55,7 @@ where
     /// Returns the “default value” for a type. [Read more](Default::default)
     ///
     /// # Panics
-    /// If [`Str::default`] produces a value which is longer than `MAX_LEN`.
+    /// If `Str::default` produces a value which is longer than `MAX_LEN`.
     fn default() -> Self {
         Self::new(Default::default())
             .unwrap_or_else(|_| panic!("A `Default` for a `Deref<Target = str>` should be empty"))

src/fields/types/max_str.rs

@@ -1,4 +1,4 @@
-//! Re-usable implementations of [`FieldType::Check`](FieldType::Check)
+//! Re-usable implementations of [`FieldType::Check`]
 
 use crate::const_fn;
 #[cfg(doc)]

src/fields/utils/check.rs

@@ -1,4 +1,4 @@
-//! Re-usable implementations of [`FieldType::GetAnnotations`](FieldType::GetAnnotations)
+//! Re-usable implementations of [`FieldType::GetAnnotations`]
 
 use crate::const_fn;
 #[cfg(doc)]

src/fields/utils/get_annotations.rs

@@ -1,4 +1,4 @@
-//! Re-usable implementations of [`FieldType::GetNames`](FieldType::GetNames)
+//! Re-usable implementations of [`FieldType::GetNames`]
 
 use crate::const_fn;
 #[cfg(doc)]

src/fields/utils/get_names.rs

@@ -1,4 +1,4 @@
-//! Utility types, traits and functions required to declare and implement the [`FieldType`] trait.
+//! Utility types, traits and functions required to declare and implement the [`FieldType`](crate::fields::traits::FieldType) trait.
 
 pub mod check;
 pub mod const_fn;

src/fields/utils/mod.rs

@@ -9,7 +9,7 @@ use crate::fields::proxy::FieldProxyImpl;
 use crate::internal::field::{Field, FieldProxy};
 use crate::internal::query_context::QueryContext;
 
-/// [`Decoder`] for a single field's [`Field::Type`](Field::Type)
+/// [`Decoder`] for a single field's [`Field::Type`]
 pub trait FieldDecoder: Decoder {
     /// Construct decoder for a specific field and path
     fn new<I>(ctx: &mut QueryContext, _: FieldProxy<I>) -> Self

src/internal/field/decoder.rs

@@ -1,4 +1,4 @@
-//! A type level version of [`imr::Annotation`](crate::imr::Annotation)
+//! A type level version of [`imr::Annotation`]
 //! to be used in generic type bound checks and a struct to store them
 
 use rorm_declaration::{imr, lints};

src/internal/hmr/annotations.rs

@@ -1,7 +1,6 @@
 //! This module holds the high level model representation
 //!
 //! It adds:
-//! - [`db_type`]: a type level version of [`imr::DbType`](crate::imr::DbType) to be used in generic type bound checks
 //! - [`annotations`]: a type level version of [`imr::Annotation`](crate::imr::Annotation) to be used in generic type bound checks
 //!
 //! These features are split into different submodules to avoid name conflicts.

src/internal/hmr/mod.rs

@@ -1,11 +1,11 @@
 //! Flat generic-less representation of a condition tree
 //!
 //! This representation is used inside the [`QueryContext`]
-//! to store a generic [`Condition`] using a concrete type
+//! to store a generic [`Condition`](crate::conditions::Condition) using a concrete type
 //! before handing it over to `rorm-sql`.
 //!
 //! There has to be a representation in between because `rorm-sql` doesn't take ownership
-//! and the `Condition` [`Column`] requires generating join aliases (owned strings)
+//! and the `Condition` [`Column`](crate::conditions::Column) requires generating join aliases (owned strings)
 //! after the use constructed his condition tree.
 
 use crate::conditions::collections::CollectionOperator;
@@ -40,7 +40,7 @@ pub enum GetConditionError {
     /// Unexpected end of slice
     MissingNodes,
 
-    /// Unexpected [`FlatCondition::EndCollection`] i.e. end without previous start
+    /// Unexpected `FlatCondition::EndCollection` i.e. end without previous start
     CollectionEnd,
 
     /// Invalid value index

src/internal/query_context/flat_conditions.rs

@@ -173,7 +173,7 @@ impl fmt::Debug for PathId {
 /// from [`ParentField::Model`](PathField::ParentField)
 /// to [`ChildField::Model`](PathField::ChildField).
 ///
-/// Implementors are fields with type [`ForeignModel`] or [`BackRef`].
+/// Implementors are fields with type [`ForeignModel`](crate::fields::types::ForeignModel) or [`BackRef`].
 ///
 /// `ChildField` and `ParentField` are not necessarily the same as `Self`
 /// but they both have to represent a single column, one of them has to