annotations vocabulary
Factor handbook ยป Vocabulary index


Documentation
Code annotations

Metadata
Tags:tools
Authors:Joe Groff, Doug Coleman


Words

Parsing words
WordSyntax
!AUTHOR
!BROKEN
!BUG
!FIXME
!HACK
!LICENSE
!LOL
!NOTE
!REVIEW
!TODO
!XXX


Ordinary words
WordStack effect
$annotation( element -- )
$annotation-usage( element -- )
$annotation-usage.( element -- )
(AUTHOR)( str -- )
(BROKEN)( str -- )
(BUG)( str -- )
(FIXME)( str -- )
(HACK)( str -- )
(LICENSE)( str -- )
(LOL)( str -- )
(NOTE)( str -- )
(REVIEW)( str -- )
(TODO)( str -- )
(XXX)( str -- )
(non-annotation-usage)( word -- usages )
(parse-annotation)( accum -- accum )
<$annotation-usage.>( word -- element )
<$annotation-usage>( word -- element )
<$annotation>( word -- element )
AUTHORs( -- usages )
AUTHORs.( -- )
BROKENs( -- usages )
BROKENs.( -- )
BUGs( -- usages )
BUGs.( -- )
FIXMEs( -- usages )
FIXMEs.( -- )
HACKs( -- usages )
HACKs.( -- )
LICENSEs( -- usages )
LICENSEs.( -- )
LOLs( -- usages )
LOLs.( -- )
NOTEs( -- usages )
NOTEs.( -- )
REVIEWs( -- usages )
REVIEWs.( -- )
TODOs( -- usages )
TODOs.( -- )
XXXs( -- usages )
XXXs.( -- )
annotation-tags( -- value )
define-annotation( NAME -- )


Files
resource:extra/annotations/annotations.factor
resource:extra/annotations/annotations-docs.factor
resource:extra/annotations/annotations-tests.factor


Metadata files
resource:extra/annotations/authors.txt
resource:extra/annotations/summary.txt
resource:extra/annotations/tags.txt


Children
VocabularySummary
annotations.private