Make your own functions behave like Blitz functions!
This feature allows you to highlight your own functions in the IDE! In addition, pressing F1 in the IDE will display the quick help for your functions (arguments and their type), pressing a second time F1 will display your html documentation in the IDE!! (notice that this feature was tested only on the official IDE).

To do this, Cod2Doc creates an userlib with your functions, and copies the html files directly in the Blitz help directory. Each function has its own html file, and therefore it implies that checking this option checks also automatically the "only functions in separate files" option.

There is two warnings to know about when using this feature:

• With this option, the functions are not written in the html folder you have specified! It means that the html files will be copied only in the Blitz directory.
• If a function definition is present more than one time in the userlibs, the Blitz IDE will crash at the startup! Cod2Doc doesn't check double functions. If it happens to you, use the "Delete userlib..." button.

This feature is very easy to use in Cod2Doc (see here for a description of the GUI). In the main window, you open the "functions only" tab, you check the option "Functions highlighted in the IDE + Quick help F1". Then you enter the name of the userlib you whish to create (the userlib is used by Blitz to highlight the functions, and to provide a quick help). You have also to precise the type of command which is concerned: 2D or 3D commands (which will determine the folder where will be copied the html files). Only the user of Blitz 3D may ask for 3D command! You have also to precise the location of the Blitz folder (for example, C:\Program Files\Blitz3D).
To start the creation of the userlib and of the help files, just push as usual the "Start" button.

If the userlib file already exists, Cod2Doc propose you either to overwrite this file, either to append the documented functions at the end of this file (or to cancel). Don't forget that a function could not be two times in userlibs: so you have to select overwrite if the functions you document are already in this userlib. Select append if you wish to add the functions at the end of the userlib file.

You are a creator of a library and you wish that other users could beneficy from the highlighting of your functions in their IDE? Then here are the steps you need to follow:

• retrieve the userlib file created by Cod2Doc (located in the userlibs\ folder of Blitz)
• zip all your functions present in the \help\commands\Xd_commands folder of Blitz, where X is 2 or 3
• provide to the users the userlib and the zip containing the help files
• ask them to place the userlib in the userlibs\ folder of Blitz
• ask them to unzip the zip containing the help files in the \help\commands\Xd_commands folder of Blitz, where X is 2 or 3

Cod2Doc allows you to delete userlibs and help files that you have previously created. Only userlib created by Cod2Doc may be removed.
Cod2Doc will remove the userlib you have selected as well as all the help files related to this userlib.

To delete userlibs, click on the "Delete userlibs..." button. Then you just select the userlib you want to remove, and click on the "Delete selected userlib" to delete it permanently (as well as all help files related to it).