Proper Lua API page

1 reply [Last post]
Lyberta
Lyberta's picture
User offline. Last seen 1 year 13 weeks ago. Offline
Joined: 2016-09-10
Posts: 177

So I'm experimenting with Lua and found that documentation is really hard to work with. I ended up with 10+ browser tabs of LuaAPI page and reference tables. I think we should make a proper API section.

I was making Company of Heroes maps with Lua dialect called SCAR and devs made a very good ScarDoc. I think we need something like this. I'm not sure if there are programs designed to make documentation for Lua, but I've found a Lua plugin for Doxygen. I use Doxygen to make documentation for my C++ code. example.

If there's a demand for such thing I guess I can do it myself. Thoughts?

Wuzzy
Wuzzy's picture
User offline. Last seen 10 hours 28 min ago. Offline
Joined: 2012-06-20
Posts: 1190

The LuaAPI page in the HWKB completely hand-written, nothing is automated. There are a few functions which are not documented on this page, but luckily those are not the important ones.
If Hedgewars would use something like Doxygen, this would help A LOT indeed.

Hi, I am a Hedgewars developer. Smile I accept personal donations in bitcoin. Heart 17fsUywHxeMHKG41UFfu34F1rAxZcrVoqH

Copyright © 2004-2017 Hedgewars Project. All rights reserved. [ contact ]