View Source ExDoc.Formatter.JSON (ExDocJSON v0.2.1)
Generates JSON documentation for Elixir projects
The ExDoc JSON formatter starts with some information at the top:
Top-level information
about
- Indicates the version of the JSON structure format.name
- Project nameversion
- Project versiondescription
- Project summary descriptionhomepage_url
- Specifies the project's home pagelanguage
- Identifies the primary language of the documents.icon
- Identifies the URL of the project's logoitems
- This JSON object contains modules, exceptions, protocols, Mix tasks, and extras details.
Modules, Exceptions, Protocols, Behaviours, and Mix tasks
Each component is an array that includes:
module
- Module nametitle
- Module titlesource_doc
- Module documentation summarydoc_line
- Line number where the module documentation startssource_path
- Path to the source code file in the projectsource_url
- URL to the source codetype
- Specifies if the component is a module, exception, etc.
Function, callback, and type details
arity
- Function aritydefaults
- Default argument valuessource_doc
- Function documentationdoc_line
- Line number where the module documentation startssource_path
- Path to the source code file in the projectsource_url
- URL to the source codesignature
- Indicates the function signatureannotations
- Show annotations
Extras
This JSON object include the following fields:
id
- Identifiertitle
- Document titlegroup
- Specifies the groupsource
- The document content in the source formatsource_path
- Path of the original documentsource_url
- URL of the original document
Summary
Functions
@spec run( [ExDoc.ModuleNode.t()] | {[ExDoc.ModuleNode.t()], [ExDoc.ModuleNode.t()]}, ExDoc.Config.t() ) :: String.t()