ferron

Ferron is a fast and simple static website generator made with Lua.
Log | Files | Refs | Submodules | README | LICENSE

commit f0af90c2a17bf3a8d39dd7d3aa840d7f1eeb77a3
parent a9936f385f71490333987e5b1f348c8c6636a1d5
Author: Hugo Soucy <hugo.soucy@equisoft.com>
Date:   Wed, 28 Aug 2019 09:17:06 -0400

Add some luadoc

Diffstat:
Mferron/utilities/file-utils.lua | 10+++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/ferron/utilities/file-utils.lua b/ferron/utilities/file-utils.lua @@ -74,6 +74,10 @@ function fileutils.isMarkdown(filepath) return false end +--- Check if the pathname target is a markdown file named index +-- @name isIndex +-- @param filepath a pathname to a file +-- @return if true the filepath param, else false function fileutils.isIndex(filepath) if fileutils.isMarkdown(filepath) and fileutils.getbasename(filepath) == 'index.md' @@ -83,7 +87,11 @@ function fileutils.isIndex(filepath) return false end - +--- Check if the pathname target is a markdown file but not named +--- index +-- @name isNotIndex +-- @param filepath a pathname to a file +-- @return if true the filepath param, else false function fileutils.isNotIndex(filepath) if fileutils.isMarkdown(filepath) and not fileutils.isIndex(filepath)