extra/tools/image-analyzer/image-analyzer-docs.factor

   1 USING: assocs help.markup help.syntax sequences strings ;
   2 IN: tools.image-analyzer
   3 FROM: tools.image-analyzer.vm => image-header ;
   4
   5 HELP: load-image
   6 { $values
   7   { "image" string }
   8   { "header" image-header }
   9   { "data-heap" sequence }
  10   { "code-heap" sequence }
  11 }
  12 { $description "Loads and decodes Factor image." } ;
  13
  14 ARTICLE: "tools.image-analyzer" "Loader for Factor images"
  15 "The " { $vocab-link "tools.image-analyzer" } " loads and decodes Factor images."
  16 $nl
  17 "Main word:"
  18 { $subsections load-image }
  19 { $notes "A limitation of the vocab is that cpu architecture of the image must match the Factor process. So 32 bit Factor can only load 32 bit images and 64 bit Factor 64 bit images." } ;
  20
  21 ABOUT: "tools.image-analyzer"