home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR2 / COBGEN.ZIP / INFO.DOC < prev    next >
Text File  |  1993-05-17  |  3KB  |  62 lines
  1. COBGEN --
  2.  
  3. This program is designed to save you hours of work when developing small,
  4. medium, or large scale OO projects in C++ It produces compile 
  5. ready header and object files.  You can use this program to produce
  6. these templates for you.  If you are working as part of a team the use of
  7. this product will ensure all your programmers follow the same basic structure
  8. and format.  If you choose to extend this method of documentation, it can
  9. provide a solid foundation upon which to write your code.  
  10.  
  11. COBGEN accepts two different command argument options:
  12.  
  13.         -f      Specification of the file from where your index of 
  14.                 relationships is.  This is a two column file with the
  15.                 first column specifying the filename by which to save
  16.                 the class under.  The second column is the actual name
  17.                 of the class.
  18.         
  19.         -p      Specification of the optional file of what you want all
  20.                 your c++ source files to contain at the top of them.  This
  21.                 would be where you would place any copyright information or
  22.                 information of that nature, common to all source files.
  23.  
  24. The sample files included:
  25.  
  26.         EXAMPLE.BAT -- Runs the example to show you what gets generated with
  27.                        the given input specifications file.
  28.         HEADER.TXT  -- A sample (-p) file.  It will prepend each of the 
  29.                        generated files with the contents of this file.
  30.         SAMPLE.TXT  -- A sample (-f) file.  This contains the two column table
  31.                        by which the files are generated from.
  32.  
  33. One of the nice features of using the two column index table file, is that
  34. when you are finished, you can use that table as a form of documentation for
  35. the source program.  If you ever want to know in which file a given class
  36. is defined, you only need look at the table.
  37.  
  38.  
  39. The generated object files (.cpp) have embedded documentation in each 
  40. service.  This provides a solid foundation upon which you code.  You can
  41. use the Key fields (such as //%Status) to do a global text search to see 
  42. which services are DONE or STUBed.  This will work as long as you document
  43. your service as you work on it.  You should place your PDL between the
  44. //BEGIN and //TERMINATE comments.
  45.  
  46. You can use the stub service as a template to paste in your object.  This 
  47. will help ensure you follow the same format on all of your services.
  48.  
  49. Note:   The header files are included with the <> method (in the generated
  50.         code).  This lets you take advantage of the path method of including
  51.         files.  If you keep your header files in the same directory as the
  52.         .cpp files, then be sure to add "." to your include path.
  53.  
  54.  
  55. If you like this program, you are invited to register your copy of it.  Send
  56. a check or money order, Payable to Au Software for TWENTY-FIVE dollars  
  57. ($25) to:
  58.                 Au Software,
  59.                 P. O. Box 96, 
  60.                 Anaheim, CA  92815-0096
  61.  
  62.