;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
;!!!!!!!!!!!!!!!!!!!!!!    Document the header     !!!!!!!!!!!!!!!!!!!!!
;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
; 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.
;! This line won't be document as it starts with the veto tag ;!
; These lines will appear at the top of the documentation.
;
; THIS HTML DOCUMENTATION WAS CREATED USING [THIS .BB SOURCE FILE]SourceMoreComplexExample.html.

;author  [RepeatUntil]repeatuntil@free.fr
;toDo  - Like for other tags, 
;+     - you can easily create a list
;+     - with several points.     ;/list

;doc 
; 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).
;/doc

;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
;!!!!!!!!!!!!    Document variables/types/functions     !!!!!!!!!!!!!!!!
;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Include "SimpleExample.bb" ; There is no comment in documentation for include files


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

;doc
; 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~.
;/doc

Type aType4
; For those who prefers, you may write the description <em> below </em>
;; the Type keyword
  Field field3 ; Description of this field
End Type


; The description of type/function could be above or below the keyword 
;; (however the priority is for description above the keyword)
; return = the description of the return value
Function aFunction(var1%, var2$, var3# = 1.)
  Return True 
End Function

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

Function aFunction2(var1%, var2$, var3# = 1.)
; For those who prefers, you may write the description <em> below </em>
;; the function keyword
; return = There is no return in this function, so that this comment won't appear
End Function

; If you don't want to document a piece of code, simply add these 2 tags:
;noDocumentation
Const constVar1 = 0
Const constVar2 = 0
;/noDocumentation


;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
;!!!!!!!!!!!!!!!!!!!!!!!!!!!    Groups     !!!!!!!!!!!!!!!!!!!!!!!!!!!!!
;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

; Behaviour of group depends on the layout you set in the main window:
; - You can group different type of variables/functions if the layout
;   is set to "Same order as the file"
; - If the layout is set to "Sorted by category", you can't mix variables with function, or
;   constant with global, etc...
; - The groups won't work when the layout is set to "Alphabetically sorted by category"
; See these examples and play with layout...

;group This is a group
;+ with several lines of description,
;;+ this one being on the same line
Global aVariable1
;doc
; Of course, you can put inline documentation inside groups!
;/doc
Global aVariable2
;/group 

; A group without title
;group 
Global aVariable3
Global aVariable4
;/group 


;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
;!!!!!!!!!!!!!!!!!!!!!!!!    Including code     !!!!!!!!!!!!!!!!!!!!!!!!
;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!


; 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)
;example -
; ; This is an example
; For i = 1 to 10
;   Print "This is an example"
; Next
;/example
;!
;code[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
;!
;code aVerySmallExample.bb
; ; 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
;/code
Function aFunction5()
End Function



;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
;!!!!!!!!!!!!!!!!!!!    Inline documentation     !!!!!!!!!!!!!!!!!!!!!!!
;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!


;doc
;line
;
; 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 <em>very useful</em> 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:
;title A title tag (;title)
;chapter A chapter tag (;chapter)
;section A section tag (;section)
;paragraph A paragraph tag (;paragraph)
;
; You can also easily add tables.

; First a table without title cell:

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

; A table with a title:

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

; You can also put some anchors anywhere in the inline documentation (notice that 
;; variables/types/functions produce automatically anchors).
;anchor aTest
; 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]aTest.
; You can also of course have a link to a variable/function of this
;; file: aFunction(). Or even in another file: SimpleExample#aGlobalVariable.
;
; Another <em> powerful</em> feature: include a description of a variable/type/function from
;; a .bb file (here the type !aType from the file SimpleExample):

;includeDescription SimpleExample#aType
;
; On top of this, all the other tags and automatic links/insertions are also available here.
; Here are a few examples:
;
; files/Cod2Doc.jpg

;code[Some code]
; ; Here is some code
; CreateAQuake-LikeGame(5, "And prepare me some coffee, please") ;)
;/code
;group A group
; some text or whatever inside this group
; * even a list
; * with 2 points   ;/list
;/group

;/doc