summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormpeterv <mpeterval@gmail.com>2016-04-18 11:12:16 +0300
committermpeterv <mpeterval@gmail.com>2016-04-18 11:19:01 +0300
commit168445086260eb3d617fe5623c8d5549c2c28df3 (patch)
treef8279fbd31f578fbde91b50f04584c550ac4fd71
parentc06845138f57eefabd28f000c3db795fad3185b1 (diff)
downloadluacov-168445086260eb3d617fe5623c8d5549c2c28df3.tar.gz
LDoc fixes
-rw-r--r--src/luacov/runner.lua3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/luacov/runner.lua b/src/luacov/runner.lua
index 8951630..f75bbf1 100644
--- a/src/luacov/runner.lua
+++ b/src/luacov/runner.lua
@@ -5,6 +5,7 @@
-- @name luacov.runner
local runner = {}
+--- LuaCov version in `MAJOR.MINOR.PATCH` format.
runner.version = "0.10.0"
local stats = require("luacov.stats")
@@ -51,6 +52,7 @@ end
--------------------------------------------------
-- Uses LuaCov's configuration to check if a file is included for
-- coverage data collection.
+-- @param filename name of the file.
-- @return true if file is included, false otherwise.
function runner.file_included(filename)
-- Normalize file names before using patterns.
@@ -304,6 +306,7 @@ end
--------------------------------------------------
-- Returns real name for a source file name
-- using `luacov.defaults.modules` option.
+-- @param filename name of the file.
function runner.real_name(filename)
local orig_filename = filename
-- Normalize file names before using patterns.