MoreComplexExample


Description:
This is the line of description of the file which will appear in the index.
You can add more line of description of the file.
These lines will appear at the top of the documentation.

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


Author:
RepeatUntil
To do:
  • Like for other tags,
  • you can easily create a list
  • with several points.

Here is an inline documentation where you can put a lot of text.
This inline documentation is related to the header.
A lot of special tags are available for inline documentation (see the last inline documentation in this file for details).


aType3
Description:
The description of type/function could be above or below the keyword (however the priority is for description above the keyword)
See also: aType4 (use of the "See also" tag)
Field description:
field1 = Description of this field

This inline documentation will be relative to the Type aType4 as it precedes it. Whatever how the layout is set, this inline documentation will be always related to aType4.

aType4
Field description:
field3 = Description of this field


aFunction(var1%,var2$,[var3#=1.])
Description:
The description of type/function could be above or below the keyword (however the priority is for description above the keyword)
Parameters:
var1%
var2$
var3# [Default value = 1.]
Return value:
the description of the return value

This inline documentation is related to the function aFunction2() as it precedes it.

aFunction2(var1%,var2$,[var3#=1.])
Parameters:
var1%
var2$
var3# [Default value = 1.]
Return value:
None


This is a group
with several lines of description, this one being on the same line

aVariable1

Of course, you can put inline documentation inside groups!

aVariable2




aVariable3


aVariable4



aFunction5()
Description:
There is several ways to import code. Here are some other methods compared to SimpleExample.bb
The first example show that if you put ";example -", then the example file is not saved
The second shows that if you use ;code, then you are able to change the title of the example
The third example shows that you can ask for another name of file (default is the name of the function)
Return value:
None
Example:
; This is an example
For i = 1 To 10
  Print "This is an example"
Next
This is an example with an user defined title:
; This is an example
For i = 1 To 10
  Print "This is an example"
Next
Code:
; This is an example with a change in the name of the file (see link)
For i = 1 To 10
  Print "This is an example"
Next


This inline documentation is related to the footer (as there is no more keywords below it). This inline documentation will demonstrate the main possibilities of this very useful feature.
If you use the ";;" tag instead of the ";" tag, different lines like this one and this one will be displayed on the same line in the browser (better like this, no ? ;).
To display text on different lines, use the ";" tag.
Like this
and this.
Another possibility to display text on different lines, just insert a blank line between them.
Like this
and this.
You can also add a blank comment ";" and a blank line will be also added.
Like this

and this.

You have a lot of layout tags:


A title tag (;title)


A chapter tag (;chapter)

A section tag (;section)

A paragraph tag (;paragraph)

You can also easily add tables.
First a table without title cell:

The title of the cell
 The text inside the cell
Another cell
with more text
 The text inside the cell
and still more text

A table with a title:

This is the table title
The first cell
 Some text
A cell without title

You can also put some anchors anywhere in the inline documentation (notice that variables/types/functions produce automatically anchors).
For example an anchor was placed on this line.


To reference it, simply write the name of the anchor with some text into brackets like this.
You can also of course have a link to a variable/function of this file: aFunction(). Or even in another file: aGlobalVariable in SimpleExample.

Another powerful feature: include a description of a variable/type/function from a .bb file (here the type aType from the file SimpleExample):

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


On top of this, all the other tags and automatic links/insertions are also available here.
Here are a few examples:



Some code
; Here is some code
CreateAQuake-LikeGame(5, "And prepare me some coffee, please") ;)


A group
some text or whatever inside this group
  1. even a list
  2. with 2 points



Documentation generated by Cod2Doc on 26 Jan 2004.