Index: doc/metadataAnalyzer-xotcl.html =================================================================== diff -u -rc72f9f638677608fab1502cd696c8f2d6b2952f9 -r4dd2595d98574faaac87f5dd33b542516fdff5df --- doc/metadataAnalyzer-xotcl.html (.../metadataAnalyzer-xotcl.html) (revision c72f9f638677608fab1502cd696c8f2d6b2952f9) +++ doc/metadataAnalyzer-xotcl.html (.../metadataAnalyzer-xotcl.html) (revision 4dd2595d98574faaac87f5dd33b542516fdff5df) @@ -3,6 +3,7 @@
- Sample sample usage: -
- package require xotcl::metadataAnalyzer + XOTcl file analyzer for @ metadata. E.g.\ used for + doumentation with xoDoc (but in the static variant + StaticMetadataAnalyzer which uses the dynamic + variant in this file). +++ Sample sample usage: +
+ package require xotcl::metadataAnalyzer - # instantiate metadata analyzer object - MetadataAnalyzer @::m - # make this object be known to @ and turn @ metadata processing on - @ analyzerObj @::m - @ onOff 1 + # instantiate metadata analyzer object + MetadataAnalyzer @::m + # make this object be known to @ and turn @ metadata processing on + @ analyzerObj @::m + @ onOff 1 - # read in some metadata tags (in sample file) & execute the file - source lib/testx.xotcl + # read in some metadata tags (in sample file) & execute the file + source lib/testx.xotcl - # turn @ metadata processing off again - @ onOff 0 + # turn @ metadata processing off again + @ onOff 0 - # print out all collected metadata - puts [@::m print] -- + # print out all collected metadata + puts [@::m print] +
- "properties" contains list of all described metadata properties. E.g. can - be printed with -
- foreach p [my set properties] { - if {[my exists $p]} { - append c " $p=[my set $p]\n" - } - } -- "name" contains the method, object, ... name of the metadata element. -
- All metadata token are aggregated by @. Therefore, -
- foreach mdt [@ info children] { - if {[$mdt istype MetadataToken]} {$mdt print} - } -- prints all token. + Each collected metadata element is stored in a token object. + MetadataToken is superclass of token object classes. Each metadata token + has two interesting parameters: +
+ "properties" contains list of all described metadata properties. E.g. can + be printed with +
+ foreach p [my set properties] { + if {[my exists $p]} { + append c " $p=[my set $p]\n" + } + } ++ "name" contains the method, object, ... name of the metadata element. +
+ All metadata token are aggregated by @. Therefore, +
+ foreach mdt [@ info children] { + if {[$mdt istype MetadataToken]} {$mdt print} + } ++ prints all token. - +