Generation of documentation for source code

Jungle Ide provides a built-in system to generate HTML based documentation files for your source code files.

This system is based on the summary keyword, but with several additions.

to generate the documentation of a Monkey source code file, each keyword (function, class, etc.) that has to be documented has to be preceded by a summary keyword.

Example:

In this example, the function will be documented.

As sometimes, a single line of text is not enough to document a function, method, etc, a complete #REM block, combined with the summary keyword can be used instead:

#Rem
summary: This function makes something very important
#End
Function Myfunction:String(Value1:Int)
       
End Function

In this example, you can see that the summary keyword is set into a complete #REM block. This allows us to make a more than one line documentation:

#Rem
summary: This function makes something very important
The first parameter is called Value1 and can be used to set something
Be aware that this function returns a String!
#End
Function Myfunction:String(Value1:Int)
       
End Function

If we do this, we get a more detailed description of the keyword in the module documentation. However, notice that only the “summary” line will be shown in the intelliprompt pop-up, while the whole text will be shown in the generated html document.

The documentation system works in a cascade way. That means that, in order to provide documentation for a class method, the class itself has to be documented too with a summary keyword.

Any documentation generated with this system will be automatically shown when the user press F1 on a documented keyword.

In order to let Jungle Ide generate the automatic documentation html documents, just go to Monkey / Generate documentation for current file, or go to Monkey / Generate documentation for current solution.

The generated documentation will be in a subfolder called .doc inside the original source code folder.