How to link to a type definition?

General Usage
, , ,
1

How can I link to a type definition in a docstring?

Not working:

"""
    calculate_AIC_matrices!(body_aero::BodyAerodynamics, model::[Model](@ref), 
                         core_radius_fraction::Float64,
                         va_norm_array::Vector{Float64}, 
                         va_unit_array::Matrix{Float64})

Calculate Aerodynamic Influence Coefficient matrices.

Returns:
    Tuple of (AIC_x, AIC_y, AIC_z) matrices
"""

In the generated html documentation I would like to be able to click on Model and would like to see the definition of this type.

2

Isn’t giving a markdown link for a type position of a function signature an issue here? E.g., maybe this will work:

"""
    calculate_AIC_matrices!(
        body_aero::BodyAerodynamics,
        model::Model,
        core_radius_fraction::Float64,
        va_norm_array::Vector{Float64},
        va_unit_array::Matrix{Float64}
    )

Calculate Aerodynamic Influence Coefficient (AIC) matrices for the given `model`,
which is of type [`Model`](@ref).
...
"""
6 Likes
3

Markdown link syntax can’t be used within a code block. Indentation of four or more spaces is one of the ways to create a code block in Markdown.

4 Likes