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 @@ XOTcl - Documentation -- ./library/lib/metadataAnalyzer.xotcl + @@ -12,7 +13,7 @@

Package/File Information

- Package provided: xotcl::metadataAnalyzer 0.84 + No package provided/required

Defined Objects/Classes: @@ -123,31 +124,31 @@ - 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
+	    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] +
+ @@ -213,9 +214,9 @@ - Token for Class metadata. Contains additional parameters: - "instprocList" = list of all instproc token. - + Token for Class metadata. Contains additional parameters: + "instprocList" = list of all instproc token. + @@ -239,8 +240,8 @@ - Token for @Constraint Metadata. - + Token for @Constraint Metadata. + @@ -264,8 +265,8 @@ - Token for @File Metadata. - + Token for @File Metadata. + @@ -289,8 +290,8 @@ - Token for Instproc metadata. - + Token for Instproc metadata. + @@ -314,8 +315,8 @@ - Token for Meta-Class metadata. - + Token for Meta-Class metadata. + @@ -379,30 +380,30 @@ - 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. + 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. - + @@ -439,8 +440,8 @@ - Abstract method for printing a token to stdout. - + Abstract method for printing a token to stdout. + @@ -470,7 +471,7 @@ Sort a token list with names. Since names are autonames, - this means order of appearance in the program. + this means order of appearance in the program. @@ -496,10 +497,10 @@ - Token for Method metadata. Contains additional parameters: - "arguments" of the method, "returnValue" of the method, - "obj" name, "abstract" = 0 or 1 (whether its an abstract method or not). - + Token for Method metadata. Contains additional parameters: + "arguments" of the method, "returnValue" of the method, + "obj" name, "abstract" = 0 or 1 (whether its an abstract method or not). + @@ -523,9 +524,9 @@ - Token for Object metadata. Contains additional parameters: - "procList" = list of all proc token and "cl"= class name. - + Token for Object metadata. Contains additional parameters: + "procList" = list of all proc token and "cl"= class name. + @@ -549,10 +550,10 @@ - Token for Package metadata. Contains additional parameters: - "version" of the package and "type"= either "require" or "provide". + Token for Package metadata. Contains additional parameters: + "version" of the package and "type"= either "require" or "provide". - + @@ -576,8 +577,8 @@ - Token for Proc metadata - + Token for Proc metadata +