Module documentation

BlitzMax Forums/BlitzMax Programming/Module documentation

matibee

(Posted 2010) [#1]

Is there a guide anywhere for bbdoc codes when writing docs?

I've tried following the layout of some existing mods but it's a bit of a painful process. For example, I've got *some* documented .bmx files compiling correctly and others being missed out.

Cheers

degac

(Posted 2010) [#2]

Well, reading the source of BBDOC

+   -   heading style (for title)

@   -   bold
%   -   italics
#   -   link (to the word)

any CODE can be used with multiple words if encapsulated by { and }
ie: @{this is all bold}

  [   - starts a table
' | ' - separates a coloumn (there are space before and after the symbol |)
  *   - starts a new row
  ]   - closes a table

 {{   - starts a code-box style
 }}   - closes a code-box style

matibee

(Posted 2010) [#3]

Thanks Degac, that's about as far as I've got.

I've got one (documented) main import file that imports the others..

Module matibee.mbmframework
ModuleInfo ..
etc

Import "1.bmx"
Import "2.bmx"
Import "3.bmx"
etc

but the compiled docs only go as far as 1.bmx, all the other files after that aren't counted.

I'll do some more digging. Brucey's Box2d mod looks an interesting and useful candidate :)

markcw

(Posted 2010) [#4]

Try using Include. ~~It's really only designed to process the main module file.~~

matibee

(Posted 2010) [#5]

Thanks mark. I tried keeping all the .bmx files as stand-alone entities, so I've not used any includes at all, but I guess that approach may be flawed. Instead I think I should "Include" as you said, or make each bmx a seperate mod inside mbmframework.mod. That would allow for compilation with selected modules rather than the whole shooting match which is what I was considering anyway.

markcw

(Posted 2010) [#6]

Actually no, I'm wrong, you should be able to use Import.

Maybe it's because the first char of the file is a number.

Brucey

(Posted 2010) [#7]

The doc stuff doesn't support Include, as far as I can remember.

Import works perfectly well - or at least it used to...

If it is not documenting your imports, it's more likely that you've missed something out along the way...

plash

(Posted 2010) [#8]

Works fine with Include for me.. And I've got plenty of modules which work that way.

Scaremonger

(Posted 2010) [#9]

Take a look at this tutorial on bbdoc...