add docs

Author: jClugstor

docs/src/interfaces/Common_Keywords.md

@@ -101,8 +101,8 @@ Note that if a method does not have adaptivity, the following rules apply:
 
 ## Memory Optimizations
 
-  - `alias_u0`: allows the solver to alias the initial condition array that is contained
-    in the problem struct. Defaults to false.
+  - `alias`: an `ODEAliases` object that holds the field `alias_u0`, which allows the solver to alias the 
+    initial condition array that is contained in the problem struct. Defaults to false.
   - `cache`: pass a solver cache to decrease the construction time. This is not implemented
     for any of the problem interfaces at this moment.
 

src/problems/linear_problems.jl

@@ -77,11 +77,22 @@ function LinearProblem(A, b, args...; kwargs...)
     end
 end
 
+@doc doc"""
+
+Holds `alias_A` and `alias_b` which determine whether 
+to alias `A` and `b` when solving a `LinearProblem`. 
+"""
 struct LinearAliases <: AbstractAliasSpecifier
     alias_A::Union{Bool,Nothing}
     alias_b::Union{Bool,Nothing}
 end
 
+"""
+    LinearAliases(;alias_A = nothing, alias_b = nothing)
+
+Creates a `LinearAliases` where `alias_A` and `alias_b` default to `nothing`.
+When `alias_A` or `alias_b` is nothing, the default value of the solver is used.
+"""
 function LinearAliases(;alias_A = nothing, alias_b = nothing)
     LinearAliases(alias_A, alias_b)
 end

src/problems/ode_problems.jl

@@ -512,11 +512,22 @@ function IncrementingODEProblem{iip}(f::IncrementingODEFunction, u0, tspan,
     ODEProblem(f, u0, tspan, p, IncrementingODEProblem{iip}(); kwargs...)
 end
 
+@doc doc"""
 
+Holds information on what variables to alias
+when solving an ODE. The field `alias_u0` determines whether the initial condition
+will be aliased when the ODE is solved. 
+"""
 struct ODEAliases <: AbstractAliasSpecifier
     alias_u0::Union{Bool,Nothing}
 end
 
+"""
+    ODEAliases(;alias_u0 = nothing)
+
+Creates an `ODEAliases`, with a default `alias_u0` value of `nothing`.
+When `alias_u0` is `nothing`, the solvers default to not aliasing `u0`.
+"""
 function ODEAliases(;alias_u0 = nothing)
     ODEAliases(alias_u0)
 end