MX2 MonkeyDoc

#rem monkeydoc Writes a 64 bit double to the databuffer

In debug builds, a runtime error will occur if `offset` is outside the range of the databuffer.
	
#param offset The offset to write.
	
#end
Method PokeDouble( offset:Int,value:Double )

#rem monkeydoc Creates a databuffer with the contents of a file.
	
@param path The file path.
	
@return A new databuffer containing the contents of `path`, or null if `path` could not be opened.
	
#end
Function Load:DataBuffer( path:String )

#Rem monkeydoc @hidden

    @hidden = Hides the doc, must appear first immediately after #rem monkeydoc

    This MonkeyDoc entry is ignored and not added to the output

#End



#Rem monkeydoc quick/short description (title)

    long description line 1

    long description line 2
    
    `Text is bold`              =  All text between ` and ` is bold.
    _Text is italics_           =  All text between _ and _ is italics.

    Lists:

    - Point 1
    - Point 2
    - Point 3


    Creating a table:

    | Header1           | Header2
    |:------------------|:-----------
    | Table Line 1      | Line 1
    | Table Line 2      | Line 2


    Important/Warning/Note:

    | `Warning:` |
    |:-----------|
    | Line 1<br> Line 2<br> Line 3


    # …                         =  Ignore line (monkeydoc comment)

    @param name description     =  Parameters

    @return description         =  Return type description

    @example                    =  Code example
     code
    @end

#End



'
' MonkeyDoc for overloaded functions/methods:
'
'    Overloaded variations are displayed all at the same help page.
'    Because of that, each overloaded function/method should have
'    different parameter names.
'    MonkeyDoc for ALL overloaded variations is written for the
'    very first overloaded variation only.
'
#Rem monkeydoc quick/short description (title)

    @param x Description for param 'x' of overload: F( x:Blah )

    @param y Description for param 'y' of overload: F( y:Int )

    @param a Description for param 'a' of overload: F( a:Int, b:Int )

    @param b Description for param 'b' of overload: F( a:Int, b:Int )

#End

Function F( x:Float )
    ' do something
End

Function F( y:Int )
    ' do something
End

Function F( a:Int, b:Int )
    ' do something
End

#rem monkeydoc
...
@param x...

#end
Function F( x:Blah )
...
End

#rem monkeydoc
...
@param x...

#end
Function F( x:int )
...
End

#rem monkeydoc

@param x

@param y - note: needed to rename 'x' param in second overload.

#end
Function F( x:Blah )
End

Function F( y:Int )
End
#end

mx2cc_macos makedocs monkey libc std sdl2

MX2CC V0.003

***** Doccing module 'monkey' *****

Parsing...
Semanting...

***** Doccing module 'libc' *****

Parsing...
Semanting...

***** Doccing module 'std' *****

Parsing...
Semanting...

***** Doccing module 'sdl2' *****

Parsing...
Semanting...

***** Doccing module 'SFML' *****

Parsing...
Semanting...
libc++abi.dylib: terminating with uncaught exception of type bbException*
./makedocs.sh: line 4: 81325 Abort trap: 6           $mx2cc makedocs
Danilos-Mac-Pro:src danilo$