[little doc idea]

BlitzMax Forums/BlitzMax Beginners Area/[little doc idea]

degac(Posted 2006) [#1]
This is nothing particular important, just an idea for Brl for the blitzmax docs.
What do you think about showing in the docs the structures of the main type(s) used by that particular 'mod'? I know that there are functions & method described, but a 'visual' structure (at the top of the help file) I think will be more intuitive to remember and to understand (at last for me), ie: Tevent has ID and others fields..., same for Tlist (addlast, addfirst...)
Just an idea.
I hope you understand what I mean...


Brucey(Posted 2006) [#2]
IF the fields were documented, they would appear in the docs...

eg.
Rem
bbdoc: This is my type!
End Rem
Type TMyOwnType

  Rem
  bbdoc: An explanation of this field...
  End Rem
  Field id:String

End Type

Cross your fingers (or/and hold your thumbs) and perhaps one day it could be like this...

:-)


tonyg(Posted 2006) [#3]
Check out Hotdocs