Code Monkey home page Code Monkey logo

Comments (5)

stevedonovan avatar stevedonovan commented on May 30, 2024

We'd like to see at least list of names of undocumented functions that a module exports. Is it possible? (Probably shouldn't be on by
default, should be an option in LDoc config.)

The obvious way would be to teach LDoc to look for the return {...} at
the end of each module and report any exported function that does not
have corresponding documentation. Your coding style makes this
relatively easy; usually LDoc is only interested in code following a
doc comment, but having the exports at the end is do-able!

Let me have a look at how this could be integrated with the rest!

(I've been playing with the idea of going beyond lexical analysis and
actually building up an AST using the metalua parser, but that's a
longer-term goal)

from ldoc.

agladysh avatar agladysh commented on May 30, 2024

Any luck?

from ldoc.

agladysh avatar agladysh commented on May 30, 2024

BTW, note that it is probably not that hard to inspect all globals too in case if module() is used.

See https://github.com/lua-aplicado/lua-aplicado/blob/master/lua-aplicado/chunk_inspector.lua (tell me if you'd like to see that a separate module... and/or contribute 5.2 support).

from ldoc.

agladysh avatar agladysh commented on May 30, 2024

Up.

from ldoc.

alerque avatar alerque commented on May 30, 2024

Contributions welcome. I don't have a lot of time to develop this myself but am trying to keep up with facilitating PRs.

from ldoc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.