On Sun, Dec 26, 2010 at 15:12, Norman Clarke <nor...@njclarke.com> wrote:
> On Thu, Dec 23, 2010 at 19:17, Dirk Feytons <dirk.feyt...@gmail.com> wrote:
>> FYI: I recently (a month or two ago) submitted a patch with some fixes
>> and enhancements to Tomás but I guess he hasn't had the time to
>> integrate it in a new release. If you're interested just let me know,
>> although I won't be able to send you the patch until I'm back at work,
>> which will be after New Year.
>
> I'm not the maintainer but am actively working on the items mentioned
> here and some other small tweaks to Luadoc, so I'd be happy to take a
> look at your patches if you want to send them when you get back to
> work.
>
> I will also be mostly on vacation until Jan 6th, so no rush.

Patch attached.

Changelog:
- Adds support for @deprecated tag. In the HTML output deprecated
functions/tables are rendered greyed-out using CSS opacity (easiest
way but not IE-friendly).
- LuaDoc was internally using a 'private' field to track whether
variables where declared as 'local'. I don't think it was used in the
output, although comments were mentioning a non-existing command line
option --nolocals. I transformed this into a new tag @scope with
possible values 'local', 'internal' and 'public'. The default is
'public'; 'local' is determined automatically by the presence of the
'local' keyword. The 'internal' value is intended for functions/tables
that are publicly visible (by traversing the module table for example)
but that are part of the implementation or not yet officially
supported and thus should not be used by external users of a module.
By default the outputted HTML documentation will not contain local and
internal things; if desired they can be included by using the --locals
 and --privates command line options.
- I changed the behavior of the util.concat(str1, str2) function: now
it also supports the case where str2 is nil and str1 isn't. This fixed
issues with parsing @see tags at the end of a comment block. Without
my change the tag name ended up with an extra space at the end, which
then caused various compares and lookups to fail, which in turn caused
the "See also" links in the HTML to have an empty href attribute.
- I also replaced string.len() calls with the # operator.


Dirk F.

Attachment: luadoc.patch
Description: Binary data

_______________________________________________
Kepler-Project mailing list
Kepler-Project@lists.luaforge.net
http://lists.luaforge.net/cgi-bin/mailman/listinfo/kepler-project
http://www.keplerproject.org/

Reply via email to