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               ALPHA BETA         RELEASE
   8 DEPRECATED    log   nothing      wont compile
   9 UNIMPLEMENTED abort abort        wont compile
  10 FIXME         log   wont compile wont compile
  11 TODO          log   log          wont compile
  12 PLANNED       log   nothing      nothing
  13 NOTREACHED    abort abort        removed
  14
  15 Legend:
  16
  17   * abort means first log and then abort
  18   * log will only log once for each sourceline (not on each hit)
  19   * wont compile will abort compilation with a error message
  20   * nothing optimized out, sane way
  21   * removed optimized out for performance reasons
  22