Documenter.jl for types constructors

General Usage
, ,
1

Hi,

I am trying to use Documenter.jl to pick up the docstrings of a custom struct called KalmanSettings for MessyTimeSeries.jl (dev branch). However, in my local enviroment,

@docs
KalmanSettings

seem to pick up only the struct, but not the constructors (aka functions). Is there a custom notation for similar problems?

EDIT

I managed to get the docstrings of these constructors by calling them manually. For instance, via

@docs
KalmanSettings(Y::Union{FloatMatrix, JMatrix{Float64}}, B::FloatMatrix, R::SymMatrix, C::FloatMatrix, Q::SymMatrix; kwargs...)
KalmanSettings

However, they appear as separate methods and thus I am still wondering whether there is a way for capturing all of them automatically as a function.

1 Like