CodeSpy Help

Created by Michael Kurz, January 2000 MichaelKurz@gmx.at - Updatet by Nils G. Svedmyr, September 2014 support@rdctools.com

CodeSpy scans files for class definitions. It recognizes properties, funtions, procedures, baseclass and imported class definitions. You should comment your code well because the comment lines before eg. a function are added as an explanation into the created html files.

1. Select a workspace .sws file and enter the source files you would like to scan for classes.
   Use the Browse button to select one or more files. You can also drag and drop files from Windows Explorer onto the grid.
2. Specify the target directory where the created html files should be written. By default the workspace Help folder is suggested.
   For every scanned source file one html file with the same name is generated, but with a .htm extension.
   The CodeSpy About files and the selected stylesheet file will be copied to the target directory by the program automatically.
3. If you’d like to scan dependencies, activate it with the checkbox. If activated, every file that is included in a scanned file is also scanned. (Of course it need to be reachable via the DF path.)
4. Then press the Generate HTML Documentation button to start generating html files.
   The main html page will always be named ClassReference.htm. The format is based on the selected stylesheet from the stylesheet comboform. You can easily change nearly everything by changing a stylesheet, or add new ones and they will get picked up by the stylesheet comboform.
5. Every class that is parsed is also added to a special class list file. You can inspect and change its contents on the "Maintain Classes" tabpage. This is because CodeSpy tries to create links between the files it has created.
   
   Example:
   // File cFile1.Pkg -> cFile1.Htm
   Class cBase is an Array
   End_Class
   
   // File cFile2.Pkg -> cFile2.Htm
   Class cNew is a cBase
   End_Class
   
   Then the base class entry in cFile.htm should be a html link to cFile1.htm
   If the cFile2.pkg is scanned before cFile1.pkg it could be necessary to scan a second time to get all links between the files. Because at the 1^st scan "cBase" isn’t in the Class list when cFile2.pkg is scanned before cFile1.pkg.
   
   Another feature is that you can add group names to the entries, so all classes are grouped by the name which is entered. You may also edit the class list manually.