diff --git a/dev/index.html b/dev/index.html index 7d78684..6594e1a 100644 --- a/dev/index.html +++ b/dev/index.html @@ -79,4 +79,4 @@ $(SIGNATURES) $(DOCSTRING) $(METHODLIST) - """

A tuple of categories can be specified when a docstring template should be used for several different categories.

@template MODULES = ModName

The template definition above will define a template for module docstrings based on the template for modules found in module ModName.

Note

Supported categories are DEFAULT, FUNCTIONS, METHODS, MACROS, TYPES, MODULES, and CONSTANTS.

source + """

A tuple of categories can be specified when a docstring template should be used for several different categories.

@template MODULES = ModName

The template definition above will define a template for module docstrings based on the template for modules found in module ModName.

Note

Supported categories are DEFAULT, FUNCTIONS, METHODS, MACROS, TYPES, MODULES, and CONSTANTS.

source diff --git a/dev/internals/index.html b/dev/internals/index.html index 89ccfc3..0e6aeba 100644 --- a/dev/internals/index.html +++ b/dev/internals/index.html @@ -3,7 +3,7 @@ function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-136089579-3', {'page_path': location.pathname + location.search + location.hash}); -
Edit on GitHub

Internals

These functions, types etc. are internal to DocStringExtensions and not part of the public API. They may change or be removed arbitrarily from version to version.

DocStringExtensions.alltypesigs — Method
alltypesigs(sig)
+
Edit on GitHub
Internals
These functions, types etc. are internal to DocStringExtensions and not part of the public API. They may change or be removed arbitrarily from version to version.
DocStringExtensions.arguments — Method
arguments(m)
 
Returns the list of arguments for a particular method m.
Examples
f(x; a = 1, b...) = x
 args = arguments(first(methods(f)))
source
DocStringExtensions.printmethod — Method
printmethod(buffer, binding, func, method)
 
Print a simplified representation of a method signature to buffer. Some of these simplifications include:
  • no TypeVars;
  • no types;
  • no keyword default values;
  • _ printed where #unused# arguments are found.
Examples
f(x; a = 1, b...) = x
 sig = printmethod(Docs.Binding(Main, :f), f, first(methods(f)))
source
DocStringExtensions.url — Method
url(m)
-
Get the URL (file and line number) where a method m is defined.
Note that this is based on the implementation of Base.url, but handles URLs correctly on TravisCI as well.
source
DocStringExtensions.Abbreviation — Type
Abbreviation objects are used to automatically generate context-dependent markdown content within documentation strings. Objects of this type interpolated into docstrings will be expanded automatically before parsing the text to markdown.
source
DocStringExtensions.Template — Type
Internal abbreviation type used to wrap templated docstrings.
Location is a Symbol, either :before or :after. dict stores a reference to a module's templates.
source

+

Get the URL (file and line number) where a method m is defined.

Note that this is based on the implementation of Base.url, but handles URLs correctly on TravisCI as well.

source
DocStringExtensions.Abbreviation — Type

Abbreviation objects are used to automatically generate context-dependent markdown content within documentation strings. Objects of this type interpolated into docstrings will be expanded automatically before parsing the text to markdown.

source
DocStringExtensions.Template — Type

Internal abbreviation type used to wrap templated docstrings.

Location is a Symbol, either :before or :after. dict stores a reference to a module's templates.

source
diff --git a/dev/search/index.html b/dev/search/index.html index 8b3abae..00befda 100644 --- a/dev/search/index.html +++ b/dev/search/index.html @@ -3,4 +3,4 @@ function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-136089579-3', {'page_path': location.pathname + location.search + location.hash}); -

Loading search...

    +

    Loading search...

      diff --git a/dev/showcase/index.html b/dev/showcase/index.html index f16109a..b4ec035 100644 --- a/dev/showcase/index.html +++ b/dev/showcase/index.html @@ -22,4 +22,4 @@ y::AbstractString ) -> AbstractArray{T, N} where {T<:Integer, N}

      For comparison, SIGNATURES abbreviation:

      bar(x, y)
-
      source

      Types

      Showcase.Foobar — Type

      The TYPEDEF abbreviation includes the type signature:

      struct Foobar{T<:AbstractString}

      The FIELDS abbreviation creates a list of all the fields of the type. If the fields has a docstring attached, that will also get included.

      • x: Docstring for the x field.

      • y

      • z: Docstring for the z field.

      TYPEDFIELDS also adds in types for the fields:

      • x::Nothing: Docstring for the x field.

      • y::AbstractString

      • z::Vector{T} where T<:AbstractString: Docstring for the z field.

      source
      +source

      Types

      Showcase.Foobar — Type

      The TYPEDEF abbreviation includes the type signature:

      struct Foobar{T<:AbstractString}

      The FIELDS abbreviation creates a list of all the fields of the type. If the fields has a docstring attached, that will also get included.

      • x: Docstring for the x field.

      • y

      • z: Docstring for the z field.

      TYPEDFIELDS also adds in types for the fields:

      • x::Nothing: Docstring for the x field.

      • y::AbstractString

      • z::Vector{T} where T<:AbstractString: Docstring for the z field.

      source