Skip to content
Snippets Groups Projects

Add ldoc support for generating lua documentation

Open Marvin Scholz requested to merge ePirat/vlc:epirat-feat-lua-docs into master
All threads resolved!

This is a proposal to add ldoc integration and necessary doc comments for VLCs Lua functions, which will allow to simply run make luadoc to generate lua documentation instead of just having poorly formatted and incomplete README files scattered in the source tree for it.

Of course this is far from complete, I am just publishing the initial draft to get feedback on it and not waste too much time on it in case there is a consensus that for some reason we do not want this approach.

I've additionally explored using Doxygen but it seems nearly impossible to properly generate any form of structured documentation for Lua with it as it was really written with C and C++ in mind.

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Marvin Scholz added 1 commit

    added 1 commit

    • 400013b3 - lua: initial work for generated documentation

    Compare with previous version

  • Good idea

  • Steve Lhomme resolved all threads

    resolved all threads

  • Marvin Scholz added 4518 commits

    added 4518 commits

    Compare with previous version

  • Marvin Scholz marked this merge request as ready

    marked this merge request as ready

  • Please register or sign in to reply
    Loading