bbDoc? where are you?

BlitzMax Forums/BlitzMax Programming/bbDoc? where are you?

TartanTangerine (was Indiepath)

(Posted 2006) [#1]

How do I build docs? bbdoc is not part of any BlitzMax install, where can I get it?

Thanks.

Dreamora

(Posted 2006) [#2]

EDIT

Sorry that was "crap"
In reality its docmods that does the doc stuff.

for example docmods brl.blitz

TartanTangerine (was Indiepath)

(Posted 2006) [#3]

yeah I tried that but it does not do anything.

It creates a folder called Doc but does not put anything in the folder.

Dreamora

(Posted 2006) [#4]

sorry was wrong.

as edited above, docs are now handled by docmods

TartanTangerine (was Indiepath)

(Posted 2006) [#5]

Do I need to flag the source in anyway? The command create the directory but does not write any files.

Dreamora

(Posted 2006) [#6]

Yes you need to.

rem
   bbdoc: SetName
end rem
method SetName(name:string)

for example.
The brl mod sources show other tags that can be used.

TartanTangerine (was Indiepath)

(Posted 2006) [#7]

Nope, been doing that, not a sausage!

Rem
bbdoc: Create
returns: Handle to Polygon Instance
about: Function Create:iPoly(x#=0,y#=0,color:Int=$FFFFFF,alpha#=1,blend:Int=ALPHABLEND,width#=18,PolyType:Byte=TYPE_TEX_LINE)
End Rem

TartanTangerine (was Indiepath)

(Posted 2006) [#8]

I must be doing something very wrong. I deleted some of the offical docs and they are rebuilt!

Dreamora

(Posted 2006) [#9]

I got the prob:

You need to have a
rem
bbdoc:name
endrem

in front of the module command itself (ie module BRL.Bank for example)

Seems like docmods needs that for the title

Luke.H

(Posted 2006) [#10]

Yes something like:

(at the start)


Rem
bbdoc: Banks
end rem
Module BRL.Bank

and also no spaces (I think) from "end rem" to the command

This should work:

Rem
bbdoc: Create a bank
End Rem
Function CreateBank:TBank( size=0 )
	Return TBank.Create( size )
End Function

But I don't think this works:

Rem
bbdoc: Create a bank
End Rem

Function CreateBank:TBank( size=0 )
	Return TBank.Create( size )
End Function

TartanTangerine (was Indiepath)

(Posted 2006) [#11]

Yeah I finally worked it out after messing with the docmods source

This Does not work :

Rem
bbdoc: Poly Module
End Rem

Module Indiepath.poly

But this does

Rem
bbdoc: Poly Module
End Rem
Module Indiepath.poly

So the moral of the story is to make sure your Parser ignores blanks lines!!!!!

Who shall I send the invoice to?

Yan	(Posted 2006) [#12]

So the moral of the story is to make sure your Parser ignores blanks lines!!!!!

...Or...

Always check the innumerable examples you have to hand. ;op

[edit for Dreamora]
:o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o) :o)
[/edit]

Dreamora

(Posted 2006) [#13]

Even with examples, this is a plain "stupid" behavior as a blank line does not tell the parser anything and thus should be ignored / dropped

Luke.H

(Posted 2006) [#14]

That took me a while to work out too,

I was just lucky I had the module bit without extra lines but half my commands I made where missing (they had extra lines) but after playing around a bit I finally worked it out

What invoice? :)

TartanTangerine (was Indiepath)

(Posted 2006) [#15]

The invoice for my wasted time.

Dreamora

(Posted 2006) [#16]

It would be better if you sent a change request ... to prevent further invoices ;-)