Module html.Writer.TemplateData.Directory

Info:

  • Copyright: 2020 wesen
  • Release: 0.1
  • License: MIT
  • Author: wesen

Class Directory

Directory:new (_fileSystemEntryCoverageData, _rootDirectoryTemplateData, _outputPathGenerator, _templateDataFactory) Directory constructor.
Directory:toTemplateValues () Generates and returns a regular table that contains all template values that are required to visualize the raw Directory coverage data.
Directory:getReportTargetName () Returns the report target name.
Directory:getChildFileSystemEntryTemplateDataObjects () Returns the template data objects of all child file system entries in the order in which they should be displayed.
Directory:generateChildFileSystemEntryTemplateValues () Generates and returns a regular table that contains the template values that are required to visualize all child file system entries.


Class Directory

Contains coverage information about a directory and its child file system entries.
Directory:new (_fileSystemEntryCoverageData, _rootDirectoryTemplateData, _outputPathGenerator, _templateDataFactory)
Directory constructor.

Parameters:

  • _fileSystemEntryCoverageData CoverageData.FileSystemEntry The raw FileSystemEntry coverage data
  • _rootDirectoryTemplateData Directory The template data of the root directory
  • _outputPathGenerator OutputPathGenerator The output path generator
  • _templateDataFactory TemplateDataFactory The TemplateData factory
Directory:toTemplateValues ()
Generates and returns a regular table that contains all template values that are required to visualize the raw Directory coverage data.

Returns:

    table The template values
Directory:getReportTargetName ()
Returns the report target name.

Returns:

    string The report target name
Directory:getChildFileSystemEntryTemplateDataObjects ()
Returns the template data objects of all child file system entries in the order in which they should be displayed.

Returns:

    FileSystemEntry[] The template data objects of the child file system entries
Directory:generateChildFileSystemEntryTemplateValues ()
Generates and returns a regular table that contains the template values that are required to visualize all child file system entries.

Returns:

    table[] The template values
generated by LDoc 1.4.6 Last updated 2020-06-01 14:04:23