SimpleExample


Description:
This is the line of description of the file which will appear in the index.
Of course you can add more line of description of the file.
These lines will appear at the top of the documentation.
Here this comment and this comment are on the same line in the documentation (thanks to ";;"!)

THIS HTML DOCUMENTATION WAS CREATED USING THIS .BB SOURCE FILE.


Author:
RepeatUntil (email address: repeatuntil@free.fr)
Project:
Describe your project here.
Version:
Write the version here
Creation:
Write the date of creation here
Last update:
Write the date of last update here
Bugs:
Write your bug here.
To do:
Write your to-do list here


aConstVariable
Description:
This comment is taken in the documentation
Constant value:
0


anotherConstVariable
Description:
Here is the description of this variable
with several lines when you use the ;+ tag and an attached line here thanks to ";;+".
Constant value:
5


aGlobalVariable
Description:
The description of the variable


anotherGlobalVariable
Default value:
1


aType
Description:
Here you put the description of the type
with as many lines as you want
Field description:
field1 = Description of this field
field2 = Description of the second field
with several lines of description with the ;+ tag and an attached lines with the ;;+ tag


aFunction(var1%,var2$,[var3#=1.])
Description:
Put here the description of the function
The description of argument is done like this:
Parameters:
var1% = here is the description of this variable
var2$ = here is the description
with the possibility to add more lines with the ;+ tag and with an attached line here with the ;;+ tag
var3# = another description [Default value = 1.]
Return value:
the description of the return value


aFunction2()
Description:
Just to show that Cod2Doc is able to insert a lot of things everywhere (as long as they are comments which will be documented)
These examples are shown inside the description of the function, but in fact they will work in the header, for variables, types, ...

Just type the name of the variable/type/function to reference it:
ex: anotherConstVariable%, aFunction() or aType
You can also put a text instead of the link
ex: You can click here or here
You can reference a variable which is an other .bb file (crossed link)
(even if they are not in the same directory as long as Cod2Doc treated them at the same time):
ex: aFunction in MoreComplexExample
Html pages (on the web or local) or bb files:
ex: http://repeatuntil.free.fr/cod2doc, a more complex example or files/SimpleExample.bb
Mail address:
repeatuntil@free.fr or even my email address
Image insertion:
or with a resize:
In all the above example, you can request that there is no automatic links/insertions by adding a ! in front of the name (you have also global options available in the main window):
ex: http://repeatuntil.free.fr, Cod2Doc.jpg
Normal list:
  • point 1
    Still point 1, still point 1 on the same line
  • point 2
Numbered list:
  1. point 1
    Still point 1
  2. point 2
Return value:
None


This is a group

myFirstVariable


mySecondVariable



aFunction3()
Description:
There is several ways to import code. Here are two methods (see the .bb file)
Return value:
None
Example:
; This is an example
For i = 1 To 10
  Print "This is an example"
Next
Example:
; This is a small example of an imported code

Repeat
  Print "Press Esc to quit this!"
Until KeyHit(1)



Documentation generated by Cod2Doc on 26 Jan 2004.