CodeSpy Info

Created by Michael Kurz, 10.01.2000 MichaelKurz@gmx.at

If you make some changes to the source code I’d be pleased if you would send it by email.

 

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.

 

How to use it:

  1. Enter the source files you would like to scan for classes.
    You can add single files with full path and filename or you can add a group of files by using wildcards "X:\Directory\*.ext".
  2. Specify the target directory where the created html files should be written.
    For every scanned source file a html file with the same name is generated.
    The html and stylesheet files which are delivered with codespy should be copied into this target directory by the program automatically.
  3. If you’d like to scan dependencies, activate it. If activated every file which is included in a scanned file is also scanned. (Of course it need to be reachable via the DF path!)
  4. Then press Generate HTML Doc to start the generation of the html files.
    The format is based on stylesheets so you can very easily change nearly everything by changing the stylesheets.
  5. Every class which was parsed is also added into a special class list file. Its contents you can see under "Maintain Classes". That’s 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 1st scan "cBase" isn’t in the Class list when cFile2.pkg is scanned before cFile1.pkg.

    You may also edit the class list manually. (adding and changing entries) Another feature is that you can add group names to the entries, so all classes are grouped by the name which is entered.