basis/ini-file/ini-file-docs.factor

   1 ! Copyright (C) 2010 John Benediktsson
   2 ! See http://factorcode.org/license.txt for BSD license
   3
   4 USING: assocs hashtables help.syntax help.markup io strings ;
   5
   6 IN: ini-file
   7
   8 HELP: read-ini
   9 { $values { "assoc" assoc } }
  10 { $description
  11     "Reads and parses an INI configuration from the " { $link input-stream }
  12     " and returns the result as a nested " { $link hashtable }
  13     "."
  14 } ;
  15
  16 HELP: write-ini
  17 { $values { "assoc" assoc } }
  18 { $description
  19     "Writes a configuration to the " { $link output-stream }
  20     " in the INI format."
  21 } ;
  22
  23 HELP: string>ini
  24 { $values { "str" string } { "assoc" assoc } }
  25 { $description
  26     "Parses the specified " { $link string } " as an INI configuration"
  27     " and returns the result as a nested " { $link hashtable }
  28     "."
  29 } ;
  30
  31 HELP: ini>string
  32 { $values { "assoc" assoc } { "str" string } }
  33 { $description
  34     "Encodes the specified " { $link hashtable } " as an INI configuration."
  35 } ;