home *** CD-ROM | disk | FTP | other *** search
/ Big Green CD 8 / BGCD_8_Dev.iso / NEXTSTEP / UNIX / Educational / R-0.49-MI / R-0.49-I / mansrc / Proto < prev   
Encoding:
Text File  |  1996-11-24  |  1.4 KB  |  55 lines
  1. COMMENT(The basic layout of a raw documentation file is as follows.)
  2. COMMENT(-----------------------------------------------------------)
  3. TITLE(~~name~~ @@ ~~~short description~~~)
  4. USAGE(
  5. One or more lines showing the synopsis of the function.
  6. These are set verbatim in typewriter font.
  7. )
  8. ALIAS(other R function with same help page)
  9. ALIAS(alias-2)
  10. ARGUMENTS(
  11. ARG(arg1 @@ Description of arg1.)
  12. ARG(arg2 @@ Description of arg2.)
  13. )
  14. DESCRIPTION(
  15. A precise description of what the function does.
  16. )
  17. VALUE(
  18. A description of the value returned.
  19. For  multiple values as list,  use 'VALUES' (below) INSTEAD...
  20. )
  21. VALUES(
  22. A description of the LIST of values returned.
  23. Use
  24. ARG(comp1 @@ Description of `comp1')
  25. ARG(comp2 @@ Description of `comp2')
  26. ...
  27. )
  28. REFERENCES(
  29. Optional references section.
  30. )
  31. SEEALSO(
  32. LANG(LINK(other help)), ....
  33. )
  34. COMMENT(------- Examples: TAKE time to do this well !!! ------------
  35.     ------- ========
  36.         They should be executable ``immediately'' by cut & paste;
  37.         i.e, you must construct data, use standard data sets, or random numbers.
  38. EXAMPLES(
  39. x <- 1:100
  40. foo.bar(x)
  41. )
  42.  
  43. COMMENT(-------------------------- just a short reminder ------------
  44. BOLD    bold font
  45. ITALIC    italic font
  46. LANG    typewriter font for language fragments
  47. ====================
  48. PARA    -- New paragraph
  49. BLANK    -- leave a blank line in an example
  50. DOTS    -- the dots in function argument list
  51. LDOTS    -- for ellipsis dots
  52.  
  53. MATH: --> See ``ABOUT''
  54. )
  55.