newb question about documentation on modules

BlitzMax Forums/BlitzMax Module Tweaks/newb question about documentation on modules

KamaShin(Posted 2005) [#1]
when downloading a module someone has made (eg: stringutil or cowergui), there is a doc folder with a "Commands.html" file containing the documentation about the module... however I have to open this command file mannually with my webbrowser... what I mean is that the commands don't appear in the BMax IDE... isn't there any other way than edtiting the NavBar.html file, to have those commands in BMax directly??


klepto2(Posted 2005) [#2]
You may search the forum about a code named documenta.
It creates helpfiles for all modules from scratch and integrates them in BMax.
Also the helpfiles look more professional.

I would give you the direct link, but I didn't find it that fast.

BTW: it also rewrites the commands.txt, so every command is highlighted.


N(Posted 2005) [#3]
Well, KamaShin, I'd try running 'bmk docmods' (or just running it 'normally', but I don't know if that works) and also make sure that the module has any code documented with the 'bbdoc' formatting. I know for a fact that Cower.GUI doesn't use 'bbdoc' but my own Doxygen-alike documentation style (written for use with my documentation generator).

Aside from that, no idea.


KamaShin(Posted 2005) [#4]
okay, thank you guys for the answers :)