Documentation drive

[xoft]

So far this is only supplementary information. The APIDump still doesn't do anything else than class reference. It has nothing on hooks, doesn't really promote using named constants, and has nothing on the style or some techniques. I think hooks are the next thing to add.

The HTML is generated completely by the plugin, by hand. It just writes the bare HTML files out from the information it collects on the exported classes. Have a look at APIDump's main.lua file. It has a DumpAPIHtm() function that does it all - it queries the exported API (by calling CreateAPITables() ), then matches that API to the documentation provided in the APIDesc file (ReadDescriptions() ), and finally spits out the class index file along with a file for each class (WriteHtmlClass() ). You can see pieces of HTML interspersed in the code. Does that answer what you were asking, or did I misunderstand the question?

---

I'm gonna document the cPluginManager class, it has seen a lot of changes since the API was last written.