From 5f98f4e9afdc411dd492d103ff7e26c258d9b935 Mon Sep 17 00:00:00 2001 From: mitchell <70453897+667e-11@users.noreply.github.com> Date: Mon, 19 Nov 2012 23:53:30 -0500 Subject: Rewrote LuaDoc. --- doc/markdowndoc.lua | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) (limited to 'doc/markdowndoc.lua') diff --git a/doc/markdowndoc.lua b/doc/markdowndoc.lua index e9dc5577..20e3fbee 100644 --- a/doc/markdowndoc.lua +++ b/doc/markdowndoc.lua @@ -12,11 +12,12 @@ local M = {} local NAVFILE = '%s* [%s](%s)\n' local FIELD = '\n### `%s` %s\n\n' -local FUNCTION = '\n### `%s` (%s)\n\n' +local FUNCTION = '\n### `%s`(*%s*)\n\n' +local FUNCTION_NO_PARAMS = '\n### `%s`()\n\n' --local FUNCTION = '### `%s` (%s)\n\n' local DESCRIPTION = '%s\n\n' local LIST_TITLE = '%s:\n\n' -local PARAM = '* `%s`: %s\n' +local PARAM = '* *`%s`*: %s\n' local USAGE = '* `%s`\n' local RETURN = '* %s\n' local SEE = '* [`%s`](%s)\n' @@ -225,8 +226,12 @@ function M.start(doc) f:write('- - -\n\n') for _, fname in ipairs(funcs) do local func = funcs[fname] - f:write(string_format(FUNCTION, func.name, func.name, - table_concat(func.param, ', '):gsub('_', '\\_'))) + local params = table_concat(func.param, ', '):gsub('_', '\\_') + if params ~= '' then + f:write(string_format(FUNCTION, func.name, func.name, params)) + else + f:write(string_format(FUNCTION_NO_PARAMS, func.name, func.name)) + end write_description(f, func.description) write_hashmap(f, PARAM, func.param) write_list(f, USAGE, func.usage) -- cgit v1.2.3