Module html.CoverageData.Total

Info:

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

Class Total

Total.filePathNormalizer The file path normalizer
Total.rootDirectoryCoverageData The coverage data of the root directory
Total.startTimestamp The timestamp when the coverage report generation was started
Total.lastFetchedFileCoverageDataFilePath The file path of the last fetched File coverage data object This is used to check if the last fetched File coverage data object can be reused instead of fetching the same object again
Total.lastFetchedFileCoverageData The last fetched File coverage data object
Total:new (_projectName) Total constructor.
Total:getRootDirectoryCoverageData () Returns the coverage data of the root directory.
Total:setStartTimestamp (_startTimestamp) Sets the timestamp when the coverage report generation was started.
Total:getStartTimestamp () Returns the timestamp when the coverage report generation was started.
Total:addEmptyLine (_filePath, _lineNumber, _line) Adds an empty line to this Total coverage data.
Total:addMissedLine (_filePath, _lineNumber, _line) Adds a missed line to this Total coverage data.
Total:addHitLine (_filePath, _lineNumber, _line, _numberOfHits) Adds a hit line to this Total coverage data.
Total:addFileHitMissStatistics (_filePath, _numberOfHits, _numberOfMisses) Adds hit/miss statistics to this Total coverage data.
Total:getOrCreateFileCoverageData (_filePath) Returns the File coverage data for a specified file.


Class Total

Contains the total coverage data for all directories and files.
Total.filePathNormalizer
The file path normalizer
  • filePathNormalizer FilePathNormalizer
Total.rootDirectoryCoverageData
The coverage data of the root directory
  • rootDirectoryCoverageData Directory
Total.startTimestamp
The timestamp when the coverage report generation was started
  • startTimestamp int
Total.lastFetchedFileCoverageDataFilePath
The file path of the last fetched File coverage data object This is used to check if the last fetched File coverage data object can be reused instead of fetching the same object again
  • lastFetchedFileCoverageFilePath string
Total.lastFetchedFileCoverageData
The last fetched File coverage data object
  • lastFetchedFileCoverageData File
Total:new (_projectName)
Total constructor.

Parameters:

  • _projectName string The project name
Total:getRootDirectoryCoverageData ()
Returns the coverage data of the root directory.

Returns:

    Directory The coverage data of the root directory
Total:setStartTimestamp (_startTimestamp)
Sets the timestamp when the coverage report generation was started.

Parameters:

  • _startTimestamp int The timestamp
Total:getStartTimestamp ()
Returns the timestamp when the coverage report generation was started.

Returns:

    int The timestamp
Total:addEmptyLine (_filePath, _lineNumber, _line)
Adds an empty line to this Total coverage data.

Parameters:

  • _filePath string The file path
  • _lineNumber int The line number of the line
  • _line string The content of the line
Total:addMissedLine (_filePath, _lineNumber, _line)
Adds a missed line to this Total coverage data.

Parameters:

  • _filePath string The file path
  • _lineNumber int The line number of the line
  • _line string The content of the line
Total:addHitLine (_filePath, _lineNumber, _line, _numberOfHits)
Adds a hit line to this Total coverage data.

Parameters:

  • _filePath string The file path
  • _lineNumber int The number of the line
  • _line string The content of the line
  • _numberOfHits int The number of times the line was executed
Total:addFileHitMissStatistics (_filePath, _numberOfHits, _numberOfMisses)
Adds hit/miss statistics to this Total coverage data.

Parameters:

  • _filePath string The file path
  • _numberOfHits int The total number of hits in the file
  • _numberOfMisses int The total number of misses in the file
Total:getOrCreateFileCoverageData (_filePath)
Returns the File coverage data for a specified file. A new File coverage data object will be created if there is none for that file yet.

Parameters:

  • _filePath string The file path whose File coverage data to return

Returns:

    File The file coverage data for the specified file
generated by LDoc 1.4.6 Last updated 2020-06-01 14:04:23