Merge pull request #1131 from abhro/alias-docstring-signatures

Move type/constructor signatures for alias types to top of docstrings

Author: ChrisRackauckas

src/problems/analytical_problems.jl

@@ -30,10 +30,10 @@ end
 export AnalyticalProblem, AbstractAnalyticalProblem
 
 @doc doc"""
+    AnalyticalAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)
 
 Holds information on what variables to alias
 when solving an AnalyticalProblem. Conforms to the AbstractAliasSpecifier interface. 
-    `AnalyticalAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)`
 
 When a keyword argument is `nothing`, the default behaviour of the solver is used.
     

src/problems/bvp_problems.jl

@@ -444,10 +444,10 @@ function TwoPointSecondOrderBVProblem(
 end
 
 @doc doc"""
+    BVPAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)
 
 Holds information on what variables to alias
 when solving an BVP. Conforms to the AbstractAliasSpecifier interface. 
-    `BVPAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)`
 
 When a keyword argument is `nothing`, the default behaviour of the solver is used.
 

src/problems/dae_problems.jl

@@ -121,10 +121,10 @@ function ConstructionBase.constructorof(::Type{P}) where {P <: DAEProblem}
 end
 
 @doc doc"""
+    DAEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)
 
 Holds information on what variables to alias
 when solving a DAE. Conforms to the AbstractAliasSpecifier interface. 
-    `DAEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)`
 
 When a keyword argument is `nothing`, the default behaviour of the solver is used.
 

src/problems/dde_problems.jl

@@ -398,10 +398,10 @@ function SecondOrderDDEProblem(f::DynamicalDDEFunction, args...; kwargs...)
 end
 
 @doc doc"""
+    DDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)
 
 Holds information on what variables to alias
 when solving a DDE. Conforms to the AbstractAliasSpecifier interface. 
-    `DDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)`
 
 When a keyword argument is `nothing`, the default behaviour of the solver is used.
 

src/problems/discrete_problems.jl

@@ -166,10 +166,10 @@ function DiscreteProblem(u0::Union{AbstractArray, Number}, tspan,
 end
 
 @doc doc"""
+    DiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)
 
 Holds information on what variables to alias
 when solving a DiscreteProblem. Conforms to the AbstractAliasSpecifier interface. 
-    `DiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)`
 
 When a keyword argument is `nothing`, the default behaviour of the solver is used.
 

src/problems/implicit_discrete_problems.jl

@@ -132,10 +132,10 @@ function ConstructionBase.constructorof(::Type{P}) where {P <: ImplicitDiscreteP
 end
 
 @doc doc"""
+    ImplicitDiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)
 
 Holds information on what variables to alias
 when solving an ODE. Conforms to the AbstractAliasSpecifier interface. 
-    `DiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)`
 
 When a keyword argument is `nothing`, the default behaviour of the solver is used.
 

src/problems/integral_problems.jl

@@ -169,10 +169,10 @@ struct SampledIntegralProblem{Y, X, K} <: AbstractIntegralProblem{false}
 end
 
 @doc doc"""
+    IntegralAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)
 
 Holds information on what variables to alias
 when solving an IntegralProblem. Conforms to the AbstractAliasSpecifier interface. 
-    `IntegralAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)``
 
 When a keyword argument is `nothing`, the default behaviour of the solver is used.
 

src/problems/linear_problems.jl

@@ -144,9 +144,10 @@ function SymbolicIndexingInterface.set_parameter!(
 end
 
 @doc doc"""
+    LinearAliasSpecifier(; alias_A = nothing, alias_b = nothing, alias = nothing)
+
 Holds information on what variables to alias
 when solving a LinearProblem. Conforms to the AbstractAliasSpecifier interface. 
-    `LinearAliasSpecifier(; alias_A = nothing, alias_b = nothing, alias = nothing)`
 
 When a keyword argument is `nothing`, the default behaviour of the solver is used.
 

src/problems/nonlinear_problems.jl

@@ -566,9 +566,10 @@ function SymbolicIndexingInterface.set_parameter!(prob::SCCNonlinearProblem, val
 end
 
 @doc doc"""
+    NonlinearAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)
+
 Holds information on what variables to alias when solving a `NonlinearProblem`. 
 Conforms to the AbstractAliasSpecifier interface. 
-    `NonlinearAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)`
 
 When a keyword argument is `nothing`, the default behaviour of the solver is used.
 

src/problems/ode_problems.jl

@@ -512,10 +512,10 @@ function IncrementingODEProblem{iip}(f::IncrementingODEFunction, u0, tspan,
 end
 
 @doc doc"""
+    ODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias_du0 = false, alias_tstops = false, alias = nothing)
 
 Holds information on what variables to alias
 when solving an ODE. Conforms to the AbstractAliasSpecifier interface. 
-    `ODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias_du0 = false, alias_tstops = false, alias = nothing)`
 
 When a keyword argument is `nothing`, the default behaviour of the solver is used.