;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
;!!!!!!!!!!!!!!!!!!!!!!    Document the header     !!!!!!!!!!!!!!!!!!!!!
;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
; 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]SourceSimpleExample.html.

;author  RepeatUntil (email address: repeatuntil@free.fr)
;project  Describe your project here.
;version  Write the version here
;creation  Write the date of creation here
;lastUpdate  Write the date of last update here
;bug  Write your bug here.
;toDo  Write your to-do list here

; These comments won't be taken into account
; as they belongs to nobody ;)


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

Include "ComplexExample.bb" 

; This comment is not taken into account
Const aConstVariable = 0 ; This comment is taken in the documentation
; This comment is not taken into account

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

Global aGlobalVariable ; The description of the variable
Global anotherGlobalVariable = 1 ;! This description is not documented as it starts with ;!


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


; Put here the description of the function
; The description of argument is done like this:
; 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
; return = the description of the return value
Function aFunction(var1%, var2$, var3# = 1.)
  Return True 
End Function


;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
;!!!!!!!!!!!!!!!!    Automatic liks and insertions      !!!!!!!!!!!!!!!!
;!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

; 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 anotherGlobalVariable[here] or [here]anotherGlobalVariable
; 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: MoreComplexExample#aFunction 
; Html pages (on the web or local) or bb files:
; ex: http://repeatuntil.free.fr/cod2doc, [a more complex example]MoreComplexExample.html or files/SimpleExample.bb
; Mail address:
; repeatuntil@free.fr or even [my email address]repeatuntil@free.fr
; Image insertion:
; Cod2Doc.jpg or with a resize: Cod2Doc.jpg[60,20]
; 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    ;/list
; Numbered list:
; * point 1
; Still point 1
; * point 2    ;/list  
Function aFunction2()
End Function


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

;group This is a group
Global myFirstVariable
Global mySecondVariable
;/group 


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

; There is several ways to import code. Here are two methods (see the .bb file)
;example
; ; This is an example
; For i = 1 to 10
;   Print "This is an example"
; Next
;/example
;!
;importExample files/ExampleImportedCode.bb
Function aFunction3()
End Function