Modules
The docstrings for these abbreviations are in the reference.
This is the Examples module that every example page draws on:
"""
This docstring belongs to the `Examples` module.
[`EXPORTS`](@ref) lists the exported names:
$(EXPORTS)
[`PUBLIC`](@ref) also lists the names declared `public`, here `bar` and `Fruit`:
$(PUBLIC)
[`IMPORTS`](@ref) lists the modules loaded with `using`:
$(IMPORTS)
[`README`](@ref) includes the package README, shown between the rules:
---
$(README)
---
[`LICENSE`](@ref) includes the package license the same way:
---
$(LICENSE)
---
"""
module Examples
using DocStringExtensions
export foo, Foobar
public bar, Fruit
include("functions.jl")
include("parameters.jl")
include("bodies.jl")
include("macros.jl")
include("types.jl")
include("enums.jl")
include("templates.jl")
end
The docstring renders as:
Examples — Module
This docstring belongs to the Examples module.
EXPORTS lists the exported names:
PUBLIC also lists the names declared public, here bar and Fruit:
IMPORTS lists the modules loaded with using:
BaseDocStringExtensions
README includes the package README, shown between the rules:
Examples.jl
The demo library for DocStringExtensions.
LICENSE includes the package license the same way:
The Examples package stands in for a real one. A real package would carry its license text in this file.