Code2Doc bother

Blitz3D Forums/Blitz3D Programming/Code2Doc bother

Picklesworth(Posted 2005) [#1]
I'm having trouble using Cod2Doc.
I can get it to create the documentation for my program, but it contains a number of includes in a subdirectory.
The program appears to notice this and operate appropriately with them, because it will list the includes with the proper links (to a subdirectory) in the actual documentation. However, it does not create documentation for these includes, and so all of those links are broken.
I'm hoping that there is a setting which I am missing.


RepeatUntil(Posted 2005) [#2]
Happy that you are using Cod2Doc!!!

If your include files are in subdirectories (which appears to be your case), then you should do the following to be able to treat them. In Cod2Doc:
- select the *directory* of your project (instead of selecting a single .bb file). This directory should contains all other subdirectories with the include files
- In the "general tab", click on "Include all subdirectories"
- Press "Start" to run Cod2Doc on this directory

This is documented here: http://repeatuntil.free.fr/cod2doc/help/files/MainWindow_main.html#generalTab

This should work. Let me know if it worked for you using this...


Picklesworth(Posted 2005) [#3]
It worked :)

Now I'm going to document every piece of code I can get my hands on!!!


RepeatUntil(Posted 2005) [#4]
Very good!