home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 3 / goldfish_volume_3.bin / files / gfx / 3d / irit / docs / prog_man / template.c
Encoding:
Text File  |  1994-09-11  |  3.0 KB  |  69 lines
  1. /*****************************************************************************
  2. *   Programmer's manual processor of IRIT- a 3d solid modeller.             *
  3. ******************************************************************************
  4. * Usage:                                     *
  5. *  prgmman [-t] [-l] [-o OutFileName] [-z] [InFileNames]             *
  6. *                                         *
  7. * Written by:  Gershon Elber                Ver 1.0, Oct. 1994   *
  8. *****************************************************************************/
  9.  
  10.  
  11. /*****************************************************************************
  12. * DESCRIPTION:                                     M
  13. * Multi line description of the function. This is a text that will be copied M
  14. * to the manual iff the end of the line is M instead of a * like this line   M
  15. *   If a V is found at the end of the line, it is copied Verbatim. Example:  M
  16. * A x + B y + C z + D w + E = 0 defined an hyper plane in four space.        V
  17. *                                         M
  18. *   Proper indentation wil be given to algorithms or sequences that begin    M
  19. * with a alpha number values followed by a point. For example:               M
  20. *                                         M
  21. * 1. One letter    which sets the option letter (i.e. 'x' for option '-x').     M
  22. *    1.1 Allow even sub sequences.                         M
  23. * 2. '!' or '%'    to determines if this option is    really optional    ('%') or     M
  24. *    it    must be provided by the user ('!').                     M
  25. * 3. '-' always.                                 M
  26. * 5. Sequences that start with either '!' or '%'.                 M
  27. *       Each sequence will be followed by one or two characters    which        M
  28. *    defines the kind of the input:                            M
  29. *    a.    d, x, o, u - integer is expected (decimal, hex, octal base or         M
  30. *          unsigned).                             M
  31. *    b.    D, X, O, U - long integer is expected (same as above).             M
  32. *    c.    f    - float    number is expected.                     M
  33. *                                         *
  34. * PARAMETERS:                                     M
  35. *   a: one per line, must have an M at the end to show up in manual.         M
  36. *   b: this parameter will no be part of the manual!                 M
  37. *                                         *
  38. * RETURN VALUE:                                     M
  39. *   void: Description of return value (M rule at EOL applies).             M
  40. *                                         *
  41. * KEYWORDS:    (optional, if a global non static, function).             M
  42. *    ProgrammerManual, manual, documenatation                 M
  43. *****************************************************************************/
  44. void ProgrammerManual(void)
  45. {
  46. }
  47.  
  48.  
  49. Functions that are obviously auxiliary  can have the postfix Aux, must be
  50. static, and can have documentation as:
  51.  
  52.  
  53. /*****************************************************************************
  54. * DESCRIPTION:                                                               *
  55. * Auxiliary function to function SymbPiecewiseRuledSrfApprox             *
  56. *****************************************************************************/
  57. static CagdSrfStruct *CagdPiecewiseRuledSrfAux(CagdSrfStruct *Srf,
  58.                            CagdBType ConsistentDir,
  59.                            CagdRType Epsilon,
  60.                            CagdSrfDirType Dir)
  61. {
  62. }
  63.  
  64.  
  65.  
  66. Empty lines, that is lines with '*' as first character and one of '*'
  67. or 'M' or V' as last are allowed in a comment but not in the middle of
  68. PARAMETERS, RETURN VALUE, or KEYWORDS blocks.
  69.