Community project - BlitzMax help files

BlitzMax Forums/BlitzMax Beginners Area/Community project - BlitzMax help files

The forum is locked. These are the original blitzbasic.com forums, kept so they can still be read. No new topics, replies or edits can be made here. To join in, head over to the Blitz3D+ forums.

Sounds like a reasonable argument - how about the official 'in-source' docs being *very* terse? i.e. purely the command name, a very short, one sentence description, and inputs / outputs?

e.g. (from memory, excuse me if I get it wrong!)

DrawText(x:int,y:int,text:string)
Draws some text on screen at a given location
x - x position
y - y position
text - text to draw


(Many are already like this anyway!)

In terms of the IDE, this could be shown as the quick help (F1, show in the status bar / tooltip / floating small window / whatever), and make the wiki content the full help shown on F1 * 2?

We would need to have a downloadable version of the wiki though. Certainly for people without permenant internet access. Maybe the syncdocs function could not only build the quick help, but also (optionally) download the wiki docs too?

Also, should / could the user guide be moved to the wiki? And all the samples?