doc/annotationtable.txt

   1
   2 The advantage of this tagging over plain source comments is that we can take
   3 some actions if we run in such a tag at compile or runtime:
   4
   5 the action to be taken when such a macro is hit depends on the build level:
   6
   7 [grid="all"]
   8 `-------------`-----`------------`-----------------------------------------
   9               ALPHA BETA         RELEASE
  10 ---------------------------------------------------------------------------
  11 DEPRECATED    log   nothing      wont compile
  12 UNIMPLEMENTED abort abort        wont compile
  13 FIXME         log   wont compile wont compile
  14 TODO          log   log          wont compile
  15 PLANNED       log   nothing      nothing
  16 NOTREACHED    abort abort        removed
  17 ---------------------------------------------------------------------------
  18
  19 Legend:
  20
  21   * abort means first log and then abort
  22   * log will only log once for each sourceline (not on each hit)
  23   * wont compile will abort compilation with a error message
  24   * nothing optimized out, sane way
  25   * removed optimized out for performance reasons
  26