rom/graphics/documentation.c

   1 /*
   2     Copyright © 2008-2010, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Autodocs for function macros
   6     Lang: english
   7 */
   8
   9
  10 /*
  11 Purpose of this file is to deliver autodoc headers for preprozessor macros.
  12 Thus they can be linked from the "SEE ALSO" chapter of other autodocs.
  13 This file contains no source code, it doesn't make sense to compile it.
  14 */
  15
  16 /*
  17 FIXME: the autodoc script can not deal with cases where function and
  18 macro have the same name but differ in case, e.g. CWait() and CWAIT().
  19 */
  20
  21 /*****************************************************************************
  22
  23     NAME
  24         AreaCircle(
  25
  26     SYNOPSIS
  27         rp,
  28         cx,
  29         cy,
  30         r );
  31
  32     FUNCTION
  33         Calls AreaEllipse with "a" and "b" set to "r".
  34
  35     INPUTS
  36
  37     RESULT
  38
  39     NOTES
  40         Implemented as macros.
  41
  42     EXAMPLE
  43
  44     BUGS
  45
  46     SEE ALSO
  47         AreaEllipse()
  48
  49     INTERNALS
  50
  51     HISTORY
  52
  53 *****************************************************************************/
  54
  55 /*****************************************************************************
  56
  57     NAME
  58         CINIT(
  59
  60     SYNOPSIS
  61         c,
  62         n );
  63
  64     LOCATION
  65
  66     FUNCTION
  67
  68     INPUTS
  69
  70     RESULT
  71
  72     NOTES
  73         Not implemented yet.
  74
  75     EXAMPLE
  76
  77     BUGS
  78
  79     SEE ALSO
  80
  81     INTERNALS
  82
  83     HISTORY
  84
  85 *****************************************************************************/
  86
  87 /*****************************************************************************
  88
  89     NAME
  90         CEND(
  91
  92     SYNOPSIS
  93         c );
  94
  95     LOCATION
  96
  97     FUNCTION
  98
  99     INPUTS
 100
 101     RESULT
 102
 103     NOTES
 104         Not implemeted yet.
 105
 106     EXAMPLE
 107
 108     BUGS
 109
 110     SEE ALSO
 111
 112     INTERNALS
 113
 114     HISTORY
 115
 116 *****************************************************************************/