bbdoc commands.
BlitzMax Forums/BlitzMax Beginners Area/bbdoc commands.
| ||
| I made a search in the forum but nothing it's coming out with the commands of the bbdoc. Also the original docs doesn't even mention their existence. I found and use some of the commands but I don't really know their usege. I think that this can be the source for the docs so I will write what I all ready know( or think that I know ). First doc your code you must write inside a rem and use the comand bbdoc: For example :
Rem
bbdoc: Blah Blah
End Rem
Function r()
code....
End Function
This will automaticaly write the docs for you. The Text in the line of bbdoc: will named Description in the docs. One thing that I fund out using the bbdoc it's that you will have to keep your text in one line. You must write all the information you wand to give in one line!? The only way thet I found out to keep the lines shorter and not have the entiry information in one line it's to press enter( change line in the ide ) only if there is a fullstop. ( . ) <br> This command will say the docs that you wand to change a line. Ok there are more tricks to do. but I will stop here as I am afraid that all this information is stored somewhere in the forum or the web or in the original docs! Also I am not the best person to write a tutorial in English. |
| ||
| Theoretically you can use all html commands as the docs are html. <br> is just the html tag for line break. |
   |