Modules

An Abbreviation that lists the exported names of a module as Documenter.jl @ref links.

Examples

julia> """
       Shapes and their areas.
       $(EXPORTS)
       """
       module Shapes
       using DocStringExtensions
       export Circle, area
       struct Circle end
       area(::Circle) = π
       end;

julia> @doc Shapes
  Shapes and their areas.

    •  Circle
    •  area

An Abbreviation that lists the public names of a module, exported or declared public, as Documenter.jl @ref links. Before Julia 1.11, which added public, it lists the exported names.

Examples

julia> """
       Shapes and their areas.
       $(PUBLIC)
       """
       module Shapes
       using DocStringExtensions
       export Circle, area
       public perimeter
       struct Circle end
       area(::Circle) = π
       perimeter(::Circle) = 2π
       end;

julia> @doc Shapes
  Shapes and their areas.

    •  Circle
    •  area
    •  perimeter

An Abbreviation that lists, sorted by name, the modules a module loads with using. The list includes Base, which every module uses implicitly.

Examples

julia> """
       Plotting helpers.
       $(IMPORTS)
       """
       module Plots
       using DocStringExtensions, Markdown
       end;

julia> @doc Plots
  Plotting helpers.

    •  Base
    •  DocStringExtensions
    •  Markdown

An Abbreviation that includes the package README: the first file in the package root whose name contains readme, in any case. It prints nothing for a module that is not part of a package.

An Abbreviation that includes the package license: the first file in the package root whose name contains license, in any case. It prints nothing for a module that is not part of a package.