export AbstractSolver/solve!, add docstring

Author: dpo

src/SolverCore.jl

@@ -8,5 +8,6 @@ using NLPModels
 
 include("logger.jl")
 include("stats.jl")
+include("solver.jl")
 
 end

src/solver.jl

@@ -1,6 +1,25 @@
+export AbstractSolver, solve!
+
 "Abstract type from which JSO solvers derive."
 abstract type AbstractSolver end
 
+"""
+    solve!(solver, model; kwargs...)
+    solve!(solver, model, stats; kwargs...)
+
+Apply `solver` to `model`.
+
+# Arguments
+
+- `solver::AbstractSolver`: solver structure to hold all storage necessary for a solve
+- `model::AbstractNLPModel`: the model solved, see `NLPModels.jl`
+- `stats::GenericExecutionStats`: stats structure to hold solution information.
+
+The first invocation allocates and returns a new `GenericExecutionStats`.
+The second one fills out a preallocated stats structure and allows for efficient re-solves.
+
+The `kwargs` are passed to the solver.
+"""
 function solve!(solver::AbstractSolver, model::AbstractNLPModel; kwargs...)
   stats = GenericExecutionStats(:unknown, model)
   solve!(solver, model, stats; kwargs...)