Skip to content
This repository has been archived by the owner on Jul 7, 2024. It is now read-only.

LDoc #2

Closed
SquidDev opened this issue Dec 8, 2014 · 4 comments
Closed

LDoc #2

SquidDev opened this issue Dec 8, 2014 · 4 comments

Comments

@SquidDev
Copy link
Member

SquidDev commented Dec 8, 2014

Port LDoc to CC, so documentation generation can be automated.
I need to think about how this should be implemented. the options are:

  1. CCML: The trouble with this is that it won't work on normal browsers
  2. HTML: Won't work in CC
  3. Custom format - in game documentation browser

A mix of 2 and 3 seem most likely, but I don't know yet.

@SquidDev SquidDev added this to the 0.2 - Extra functionality milestone Jan 9, 2015
@jaredallard
Copy link

What's the status of this? If it's not done I'd be fully willing to contribute to a fork of LDoc.

I know HTML/CSS very well, and could easily make a IG parser.

@SquidDev
Copy link
Member Author

I've done absolutely nothing on this, but my current project is partially aimed at Howl - I'm trying to update MetaLua so I can resolve Moonscript, Lua and Tua to one single AST format. The tree will include comments so it should be easier to parse the extracted comments then using patterns. However I see no harm in starting an LDoc port.

@dmarcuse
Copy link

dmarcuse commented Mar 9, 2016

I think the best way to do it would be to generate HTML with extra comments that can be parsed by a CC program - that would make it usable both in and out of CC.

@SquidDev SquidDev removed this from the 0.2 - Extra functionality milestone Oct 17, 2016
@SquidDev
Copy link
Member Author

Whilst it would be nice to use a custom version of LDoc which parses Lua and handles scope, for now using the default is good enough.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants