home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_2.iso / files / 764a.lha / dorev_v0.3 / dorev.doc < prev    next >
Text File  |  1992-06-20  |  2KB  |  58 lines
  1.  
  2.  
  3.  
  4.                    DoRev v0.3 - Little Documentation
  5.                    ---------------------------------
  6.                   
  7.  
  8. 1. Why ?
  9.  
  10. I've seen many times those nice sources headers built automatically, and so
  11. I searched some programs that made them, but none was what I wanted.
  12. So I begun programming this little utility for programmers and in two
  13. days I finished it. I hope you would like it...
  14.  
  15. 2. How it works ?
  16.  
  17. In the header that it creates, there's two parts :
  18. The Generic part and the History part.
  19. The Generic part contents are as follows :
  20.  
  21.  Name          : The name of the program (module).
  22.  Copyright     : (optional) The copyright.
  23.  Creation Date : When the program (module) was first created.
  24.  Translator    : (optional) The compiler that the programmer use.
  25.  Compiler opts.: (optional) The options to compile the program (module).
  26.  
  27. The History part is formed of variable number of lines with :
  28.  
  29.  Date          : When the revision was made.
  30.  Rev           : The revision number.
  31.  Author        : The author of the revision.
  32.  Comment       : Should be clear :-)
  33.  
  34. 3. How to use it.
  35.  
  36. All is controlled by the commandline, type in the CLI "DoRev ?" and all should
  37. be clear.
  38. DoRev watch before the commandline and then the source file.
  39. You can for example do not specify the copyright : If DoRev finds a copyright
  40. in the source file, it will repeat the source's copyright. But if it doesn't find
  41. the copyright neither in the source, the copyright line wouldn't be generated.
  42. Another feature of DoRev is that some text may be specified in env-variables :
  43. Copyright, Translator, CompilerOpts, Author : Are env-varables that can be
  44. set with the "SetEnv" command. This is very useful : for example you can
  45. save your copyright (store the env-variable in ENVARC:) and you haven't
  46. to write it every time you make a new header. To make DoRev ignore the env-variables, 
  47. set the NOENV switch in the commandline.
  48.  
  49. 4. Greetings...
  50.  
  51. I would like to thank especially the "Amiga Club Ticino" and it's
  52. "Programmatori Amiga Ticino" with all the members of this neat group.
  53.  
  54.  
  55.  
  56.                          David Schweikert (2:301/681.4@fidonet.org)
  57.  
  58.