[Gd-chatter] r11223 - in trunk/documentation/gwydion/gdcore: project text

agent at gwydiondylan.org agent at gwydiondylan.org
Sun Mar 4 03:59:12 CET 2007


Author: agent
Date: Sun Mar  4 03:58:58 2007
New Revision: 11223

Modified:
   trunk/documentation/gwydion/gdcore/project/Menu.txt
   trunk/documentation/gwydion/gdcore/text/lang-notes.txt
   trunk/documentation/gwydion/gdcore/text/module.system.dylan.txt
   trunk/documentation/gwydion/gdcore/text/name.Dmaximum-buffer-size.txt
   trunk/documentation/gwydion/gdcore/text/name.Lbuffer-indexR.txt
   trunk/documentation/gwydion/gdcore/text/name.LbufferR.txt
   trunk/documentation/gwydion/gdcore/text/name.Lbyte-stringR.txt
   trunk/documentation/gwydion/gdcore/text/name.LcharacterR.txt
   trunk/documentation/gwydion/gdcore/text/name.Ldesignator-classR.txt
   trunk/documentation/gwydion/gdcore/text/name.LfunctionR.txt
   trunk/documentation/gwydion/gdcore/text/name.LintegerR.txt
   trunk/documentation/gwydion/gdcore/text/name.LobjectR.txt
   trunk/documentation/gwydion/gdcore/text/name.Lraw-pointerR.txt
   trunk/documentation/gwydion/gdcore/text/name.LstringR.txt
   trunk/documentation/gwydion/gdcore/text/name.Lunicode-stringR.txt
   trunk/documentation/gwydion/gdcore/text/name.LvectorR.txt
   trunk/documentation/gwydion/gdcore/text/name.alignment-of.txt
   trunk/documentation/gwydion/gdcore/text/name.buffer-address.txt
   trunk/documentation/gwydion/gdcore/text/name.buffer-end-setter.txt
   trunk/documentation/gwydion/gdcore/text/name.buffer-end.txt
   trunk/documentation/gwydion/gdcore/text/name.buffer-next-setter.txt
   trunk/documentation/gwydion/gdcore/text/name.buffer-next.txt
   trunk/documentation/gwydion/gdcore/text/name.c-decl.txt
   trunk/documentation/gwydion/gdcore/text/name.c-expr.txt
   trunk/documentation/gwydion/gdcore/text/name.c-include.txt
   trunk/documentation/gwydion/gdcore/text/name.c-literal.txt
   trunk/documentation/gwydion/gdcore/text/name.c-local-decl.txt
   trunk/documentation/gwydion/gdcore/text/name.c-struct-field-setter.txt
   trunk/documentation/gwydion/gdcore/text/name.c-struct-field.txt
   trunk/documentation/gwydion/gdcore/text/name.c-system-include.txt
   trunk/documentation/gwydion/gdcore/text/name.call-out.txt
   trunk/documentation/gwydion/gdcore/text/name.callback-entry.txt
   trunk/documentation/gwydion/gdcore/text/name.callback-method.txt
   trunk/documentation/gwydion/gdcore/text/name.copy-bytes.txt
   trunk/documentation/gwydion/gdcore/text/name.designator-class-definer.txt
   trunk/documentation/gwydion/gdcore/text/name.environment-variable.txt
   trunk/documentation/gwydion/gdcore/text/name.export-string.txt
   trunk/documentation/gwydion/gdcore/text/name.get-time-of-day.txt
   trunk/documentation/gwydion/gdcore/text/name.getenv.txt
   trunk/documentation/gwydion/gdcore/text/name.import-string.txt
   trunk/documentation/gwydion/gdcore/text/name.no-core-dumps.txt
   trunk/documentation/gwydion/gdcore/text/name.pointer-deref-setter.txt
   trunk/documentation/gwydion/gdcore/text/name.pointer-deref.txt
   trunk/documentation/gwydion/gdcore/text/name.referenced-type.txt
   trunk/documentation/gwydion/gdcore/text/name.run-application.txt
   trunk/documentation/gwydion/gdcore/text/name.size-of.txt
   trunk/documentation/gwydion/gdcore/text/name.system.txt
   trunk/documentation/gwydion/gdcore/text/name.vector-elements-address.txt
Log:
Bug: 7344
Documented system module from dylan library.



Modified: trunk/documentation/gwydion/gdcore/project/Menu.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/project/Menu.txt	(original)
+++ trunk/documentation/gwydion/gdcore/project/Menu.txt	Sun Mar  4 03:58:58 2007
@@ -1114,7 +1114,7 @@
       File: defargparser-init  (name.defargparser-init.txt)
       File: defargparser-rec  (name.defargparser-rec.txt)
       File: defargparser-synopsis  (name.defargparser-synopsis.txt)
-      File: designator-class-definer  (name.designator-class-definer.txt)
+      File: name.designator-class-definer.txt  (name.designator-class-definer.txt)
       File: domain-definer  (name.domain-definer.txt)
       File: dynamic-bind  (name.dynamic-bind.txt)
       File: for  (name.for.txt)
@@ -1178,5 +1178,6 @@
    Constant Index: Constants
    Dylan Class Index: Classes
    Macro Index: Macros
+   Property Index: Properties
    }  # Group: Indexes
 

Modified: trunk/documentation/gwydion/gdcore/text/lang-notes.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/lang-notes.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/lang-notes.txt	Sun Mar  4 03:58:58 2007
@@ -62,15 +62,15 @@
 
 
 Classes:
-abstract   - The class may not be instantiated.
-concrete   - The class may be instantiated.
-free       - The class is not restricted to a single inheritance chain.
-functional - The class only has constant slots. Equality is defined by slot
-             value and object class.
-open       - The class may be subclassed.
-primary    - The class forms a single inheritance chain with other primary
-             classes.  
-sealed     - The class may not be subclassed.
+abstract     - The class may not be instantiated.
+concrete     - The class may be instantiated.
+free         - The class is not restricted to a single inheritance chain.
+functional   - The class only has constant slots. Equality is defined by slot
+               value and object class.
+open         - The class may be subclassed.
+primary      - The class forms a single inheritance chain with other primary
+               classes.  
+sealed       - The class may not be subclassed.
 
 
 Slots:

Modified: trunk/documentation/gwydion/gdcore/text/module.system.dylan.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/module.system.dylan.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/module.system.dylan.txt	Sun Mar  4 03:58:58 2007
@@ -1,8 +1,8 @@
 Module: Module system
 ==============================
 
-The System module exports an interface to operating system calls and special,
-low-level functionality.
+The System module exports an interface to the C language (the C-FFI) and
+certain operating system calls.
 
 
 Exported from:
@@ -10,6 +10,31 @@
 #Library Dylan#
 
 
+Topic: C type symbols
+------------------------------
+Several macros use the following symbols to represent C
+types:
+
+#"boolean"        - int
+#"byte"           - char
+#"char"           - char
+#"double"         - double
+#"float"          - float
+#"int"            - int
+#"long"           - long
+#"long-double"    - long double
+#"long-long"      - long long
+#"ptr"            - void *
+#"short"          - short
+#"ubyte"          - unsigned char
+#"uint"           - unsigned int
+#"unsigned-char"  - unsigned char
+#"unsigned-int"   - unsigned int
+#"unsigned-short" - unsigned short
+#"ushort"         - unsigned short
+#"void"           - void, for return types only
+
+
 Topic: system names
 ------------------------------
 - #$maximum-buffer-size#

Modified: trunk/documentation/gwydion/gdcore/text/name.Dmaximum-buffer-size.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Dmaximum-buffer-size.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.Dmaximum-buffer-size.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Constant: $maximum-buffer-size
 ==============================
 
-A constant.
+The maximum size of a #<buffer>#.
 
 
 Exported from:
@@ -11,7 +11,7 @@
 
 Type:
 ------------------------------
-#<object>#
+#<integer>#
 
 
 Value:

Modified: trunk/documentation/gwydion/gdcore/text/name.Lbuffer-indexR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Lbuffer-indexR.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.Lbuffer-indexR.txt	Sun Mar  4 03:58:58 2007
@@ -1,12 +1,55 @@
+Title: <buffer-index>
+==============================
+
+There are two unrelated types named #<buffer-index>#. The one exported from
+#Module system# represents a byte index. The one exported from #Module
+streams# represents an element index.
+
+
 Constant: <buffer-index>
 ==============================
 
-A constant.
+A class representing an byte index within a #<buffer>#.
 
 
 Exported from:
 ------------------------------
 - #Module system#
+
+
+Type:
+------------------------------
+#<object>#
+
+
+Value:
+------------------------------
+#<integer>#
+
+
+Functions on <buffer-index>:
+------------------------------
+- #buffer-end-setter#
+- #buffer-next-setter#
+
+
+Functions returning <buffer-index>:
+------------------------------
+- #buffer-end#
+- #buffer-end-setter#
+- #buffer-next#
+- #buffer-next-setter#
+
+
+
+Constant: <buffer-index>
+==============================
+
+A class.
+
+
+Exported from:
+------------------------------
 - #Module streams#
 
 
@@ -17,5 +60,20 @@
 
 Value:
 ------------------------------
-<integer>
+#<integer>#
+
+
+Functions on <buffer-index>:
+------------------------------
+- #buffer-end-setter#
+- #buffer-next-setter#
+
+
+Functions returning <buffer-index>:
+------------------------------
+- #buffer-end#
+- #buffer-end-setter#
+- #buffer-next#
+- #buffer-next-setter#
+
 

Modified: trunk/documentation/gwydion/gdcore/text/name.LbufferR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LbufferR.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.LbufferR.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,16 @@
+Title: <buffer>
+==============================
+
+There are two unrelated #<buffer># classes. The one exported from #Module
+system# represents an in-memory buffer, and the one exported from #Module
+streams# represents a stream buffer that is owned by a stream and contains
+arbitrary types.
+
+
 Class: <buffer>
 ==============================
 
-A class.
+The class of memory buffers.
 
 
 Exported from:
@@ -14,6 +23,16 @@
 concrete free sealed
 
 
+Make keywords:
+------------------------------
+next: - An instance of #<buffer-index>#. Defaults to 0.
+end:  - An instance of #<buffer-index>#. Defaults to 0.
+fill: - An instance of #<byte># specifying an initial value for every byte of
+        the buffer. Defaults to 0x00.
+size: - An instance of #<integer># specifying the size of the vector.  The
+        default value is 0.
+
+
 Superclasses:
 ------------------------------
 - #<simple-vector>#
@@ -21,10 +40,12 @@
 
 Functions on <buffer>:
 ------------------------------
-- #buffer-start#
-- #buffer-subsequence#
-- #copy-from-buffer!#
-- #copy-into-buffer!#
+- #buffer-address#
+- #buffer-end#
+- #buffer-end-setter#
+- #buffer-next#
+- #buffer-next-setter#
+- #copy-bytes#
 
 
 
@@ -51,6 +72,10 @@
 
 Functions on <buffer>:
 ------------------------------
+- #buffer-end#
+- #buffer-end-setter#
+- #buffer-next#
+- #buffer-next-setter#
 - #buffer-start#
 - #buffer-subsequence#
 - #copy-from-buffer!#

Modified: trunk/documentation/gwydion/gdcore/text/name.Lbyte-stringR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Lbyte-stringR.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.Lbyte-stringR.txt	Sun Mar  4 03:58:58 2007
@@ -33,6 +33,7 @@
 
 Functions on <byte-string>:
 ------------------------------
+- #copy-bytes#
 - #debugger-message#
 - #debug-message#
 - #environment-variable#
@@ -49,6 +50,7 @@
 - #application-name#
 - #environment-variable#
 - #environment-variable-setter#
+- #getenv#
 - #import-string#
 - #join#
 

Modified: trunk/documentation/gwydion/gdcore/text/name.LcharacterR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LcharacterR.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.LcharacterR.txt	Sun Mar  4 03:58:58 2007
@@ -26,6 +26,7 @@
 - #alphabetic?#
 - #alphanumeric?#
 - #byte-character?#
+- #c-literal#
 - #control?#
 - #digit?#
 - #digit-to-integer#
@@ -40,6 +41,7 @@
 
 Functions returning <character>:
 ------------------------------
+- #c-literal#
 - #command-line-option-prefix#
 - #file-system-separator#
 - #integer-to-digit#

Modified: trunk/documentation/gwydion/gdcore/text/name.Ldesignator-classR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Ldesignator-classR.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.Ldesignator-classR.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,9 @@
 Class: <designator-class>
 ==============================
 
-A class.
+A designator class carries the essential properties of a C type such as its
+size and alignment. Designator classes are best constructed via
+#designator-class-definer#.
 
 
 Exported from:
@@ -14,9 +16,33 @@
 concrete free sealed
 
 
+Make keywords:
+------------------------------
+size:             - An instance of #<integer>#. Required. The C type's size in
+                    sizeof units.
+                    
+alignment:        - An instance of #<integer>#. Required. The C type's
+                    required alignment, a power of 2 in sizeof units.
+                    
+referenced-type:  - An instance of #<designator-class># or #f if the C type
+                    is not a pointer type. The designator class for what this
+                    pointer C type refers to. Defaults to #f.
+
+
 Superclasses:
 ------------------------------
 - #<class>#
  
 
+Functions on <designator-class>:
+------------------------------
+- #alignment-of#
+- #referenced-type#
+- #size-of#
+
+
+Functions returning <designator-class>#:
+------------------------------
+- #designator-class-definer#
+- #referenced-type#
 

Modified: trunk/documentation/gwydion/gdcore/text/name.LfunctionR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LfunctionR.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.LfunctionR.txt	Sun Mar  4 03:58:58 2007
@@ -36,6 +36,7 @@
 - #applicable-method?#
 - #apply#
 - #assoc#
+- #callback-entry#
 - #choose#
 - #choose-by#
 - #choose-map#

Modified: trunk/documentation/gwydion/gdcore/text/name.LintegerR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LintegerR.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.LintegerR.txt	Sun Mar  4 03:58:58 2007
@@ -32,6 +32,7 @@
 - #byte-vector-fill#
 - #byte-vector-ref#
 - #byte-vector-ref-setter#
+- #c-literal#
 - #copy-bytes#
 - #copy-from-buffer!#
 - #copy-into-buffer!#
@@ -51,6 +52,8 @@
 - #isqrt#
 - #logbit?#
 - #multi-buffered-stream-position-setter#
+- #pointer-deref#
+- #pointer-deref-setter#
 - #position#
 - #pprint-indent#
 - #pprint-logical-block#
@@ -83,8 +86,10 @@
 Functions returning <integer>:
 ------------------------------
 - #adjust-stream-position#
+- #alignment-of#
 - #bit-count#
 - #buffer-start#
+- #c-literal#
 - #case-insensitive-string-hash#
 - #collection-hash#
 - #current-timestamp#
@@ -119,6 +124,7 @@
 - #row-major-index#
 - #run-application#
 - #sequence-hash#
+- #size-of#
 - #string-hash#
 - #stream-position#
 - #stream-position-setter#

Modified: trunk/documentation/gwydion/gdcore/text/name.LobjectR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LobjectR.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.LobjectR.txt	Sun Mar  4 03:58:58 2007
@@ -68,7 +68,6 @@
 - #add-new#
 - #add-new!#
 - #add-option-parser-by-type#
-- #alignment-of#
 - #alist-delete#
 - #always#
 - #any?#
@@ -86,16 +85,14 @@
 - #buffer-address#
 - #buffer-dirty?#
 - #buffer-dirty?-setter#
-- #buffer-end#
-- #buffer-end-setter#
 - #buffer-fill#
-- #buffer-next#
-- #buffer-next-setter#
 - #buffer-position#
 - #buffer-position-setter#
 - #buffer-size#
 - #buffer-start-setter#
-- #callback-entry#
+- #c-expr#
+- #c-struct-field-setter#
+- #call-out#
 - #case-insensitive-equal#
 - #cerror#
 - #check-type#
@@ -250,6 +247,7 @@
 - #pair-foldl#
 - #pair-foldr#
 - #peek#
+- #pointer-deref-setter#
 - #position#
 - #positive?#
 - #precedes?#
@@ -282,7 +280,6 @@
 - #reduce#
 - #reduce-l#
 - #reduce-r#
-- #referenced-type#
 - #regexp-position#
 - #regexp-replace#
 - #remove#
@@ -317,7 +314,6 @@
 - #singleton#
 - #singleton-object#
 - #size#
-- #size-of#
 - #size-setter#
 - #skip-through#
 - #slot-initialized?#
@@ -372,7 +368,6 @@
 - #values#
 - #values-hash#
 - #vector#
-- #vector-elements-address#
 - #word-size#
 - #writable-file-stream-position-setter#
 - #write#
@@ -391,7 +386,6 @@
 - #+#
 - #abs#
 - #add-last#
-- #alignment-of#
 - #all-superclasses#
 - #any?#
 - #apply#
@@ -407,16 +401,15 @@
 - #buffer-address#
 - #buffer-dirty?#
 - #buffer-dirty?-setter#
-- #buffer-end#
-- #buffer-end-setter#
 - #buffer-fill#
-- #buffer-next#
-- #buffer-next-setter#
 - #buffer-position#
 - #buffer-position-setter#
 - #buffer-size#
 - #buffer-start-setter#
-- #callback-entry#
+- #c-expr#
+- #c-struct-field#
+- #c-struct-field-setter#
+- #call-out#
 - #check-type#
 - #class-name#
 - #collector-protocol#
@@ -513,6 +506,7 @@
 - #outer-stream#
 - #outer-stream-setter#
 - #peek#
+- #pointer-deref#
 - #pop#
 - #pop-last#
 - #predecessor#
@@ -539,7 +533,6 @@
 - #reduce1#
 - #reduce-l#
 - #reduce-r#
-- #referenced-type#
 - #regexp-matches#
 - #restart-query#
 - #return-query#
@@ -564,7 +557,6 @@
 - #short-option-names-setter#
 - #signal#
 - #singleton-object#
-- #size-of#
 - #size-setter#
 - #source-index#
 - #ssv-data#
@@ -598,7 +590,6 @@
 - #uppercase?#
 - #value#
 - #values#
-- #vector-elements-address#
 - #word-size#
 - #writable-file-stream-position-setter#
 

Modified: trunk/documentation/gwydion/gdcore/text/name.Lraw-pointerR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Lraw-pointerR.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.Lraw-pointerR.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Class: <raw-pointer>
 ==============================
 
-A class.
+A class representing a memory address. An instance of #<raw-pointer># is created via #as# on an #<integer>#.
 
 
 Exported from:
@@ -21,15 +21,22 @@
 
 Functions on <raw-pointer>:
 ------------------------------
+- #c-struct-field#
+- #c-struct-field-setter#
+- #call-out#
 - #general-object-at#
 - #heap-object-at#
 - #import-string#
+- #pointer-deref#
+- #pointer-deref-setter#
 
 
 Functions returning <raw-pointer>:
 ------------------------------
+- #callback-entry#
 - #export-string#
 - #object-address#
+- #vector-elements-address#
 
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.LstringR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LstringR.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.LstringR.txt	Sun Mar  4 03:58:58 2007
@@ -40,6 +40,14 @@
 Functions on <string>:
 ------------------------------
 - #break#
+- #c-decl#
+- #c-expr#
+- #c-include#
+- #c-local-decl#
+- #c-struct-field#
+- #c-struct-field-setter#
+- #c-system-include#
+- #call-out#
 - #case-insensitive-string-hash#
 - #cerror#
 - #condition-format#

Modified: trunk/documentation/gwydion/gdcore/text/name.Lunicode-stringR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Lunicode-stringR.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.Lunicode-stringR.txt	Sun Mar  4 03:58:58 2007
@@ -31,4 +31,6 @@
 - #<vector>#
  
 
-
+Functions on <unicode-string>:
+------------------------------
+- #copy-bytes#

Modified: trunk/documentation/gwydion/gdcore/text/name.LvectorR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LvectorR.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.LvectorR.txt	Sun Mar  4 03:58:58 2007
@@ -49,6 +49,7 @@
 ------------------------------
 - #find-first-key#
 - #find-last-key#
+- #vector-elements-address#
 
 
 Methods returning <vector>:

Modified: trunk/documentation/gwydion/gdcore/text/name.alignment-of.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.alignment-of.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.alignment-of.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Generic: alignment-of
 ==============================
 
-A generic function.
+Returns the alignment of a C type.
 
 
 Exported from:
@@ -16,12 +16,12 @@
 
 Arguments:
 ------------------------------
-arg - An instance of #<object>#. 
+arg - An instance of #<designator-class># for a C type.
 
 
 Values:
 ------------------------------
-#rest more - Instances of #<object>#. 
+val - An instance of #<integer>#, a power of 2 in sizeof units.
 
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.buffer-address.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.buffer-address.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.buffer-address.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Generic: buffer-address
 ==============================
 
-A generic function.
+Returns the address of the start of a memory buffer.
 
 
 Exported from:
@@ -16,12 +16,12 @@
 
 Arguments:
 ------------------------------
-arg - An instance of #<object>#. 
+buf - An instance of #<buffer># (from the system module). 
 
 
 Values:
 ------------------------------
-#rest more - Instances of #<object>#. 
+ptr - An instance of #<raw-pointer>#. 
 
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.buffer-end-setter.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.buffer-end-setter.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.buffer-end-setter.txt	Sun Mar  4 03:58:58 2007
@@ -1,12 +1,47 @@
+Title: buffer-end-setter
+==============================
+
+There are two unrelated functions named #buffer-end-setter#. The one exported
+from #Module system# relates to a memory buffer. The one exported from #Module
+streams# relates to a stream buffer.
+
+
 Generic: buffer-end-setter
 ==============================
 
-A generic function.
+Sets the "end" mark of a buffer.
 
 
 Exported from:
 ------------------------------
 - #Module system#
+
+
+Modifiers:
+------------------------------
+sealed
+
+
+Arguments:
+------------------------------
+end - An instance of #<buffer-index>#. 
+buf - An instance of #<buffer>#. 
+
+
+Values:
+------------------------------
+end - An instance of #<buffer-index>#. The _end_ argument.
+
+
+
+Generic: buffer-end-setter
+==============================
+
+A generic function.
+
+
+Exported from:
+------------------------------
 - #Module streams#
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.buffer-end.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.buffer-end.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.buffer-end.txt	Sun Mar  4 03:58:58 2007
@@ -1,12 +1,46 @@
+Title: buffer-end
+==============================
+
+There are two unrelated functions named #buffer-end#. The one exported from
+#Module system# relates to a memory buffer. The one exported from #Module
+streams# relates to a stream buffer.
+
+
 Generic: buffer-end
 ==============================
 
-A generic function.
+Returns the "end" mark of a buffer.
 
 
 Exported from:
 ------------------------------
 - #Module system#
+
+
+Modifiers:
+------------------------------
+sealed
+
+
+Arguments:
+------------------------------
+buf - An instance of #<buffer># (from the system module). 
+
+
+Values:
+------------------------------
+index - An instance of #<buffer-index>#. 
+
+
+
+Generic: buffer-end
+==============================
+
+A generic function.
+
+
+Exported from:
+------------------------------
 - #Module streams#
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.buffer-next-setter.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.buffer-next-setter.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.buffer-next-setter.txt	Sun Mar  4 03:58:58 2007
@@ -1,12 +1,47 @@
+Title: buffer-next-setter
+==============================
+
+There are two unrelated functions named #buffer-next-setter#. The one exported
+from #Module system# relates to a memory buffer. The one exported from #Module
+streams# relates to a stream buffer.
+
+
 Generic: buffer-next-setter
 ==============================
 
-A generic function.
+Sets the "next" mark of a buffer.
 
 
 Exported from:
 ------------------------------
 - #Module system#
+
+
+Modifiers:
+------------------------------
+sealed
+
+
+Arguments:
+------------------------------
+next - An instance of #<buffer-index>#. 
+buf - An instance of #<buffer>#. 
+
+
+Values:
+------------------------------
+next - An instance of #<buffer-index>#. The _next_ argument.
+
+
+
+Generic: buffer-next-setter
+==============================
+
+A generic function.
+
+
+Exported from:
+------------------------------
 - #Module streams#
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.buffer-next.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.buffer-next.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.buffer-next.txt	Sun Mar  4 03:58:58 2007
@@ -1,12 +1,46 @@
+Title: buffer-next
+==============================
+
+There are two unrelated functions named #buffer-next#. The one exported
+from #Module system# relates to a memory buffer. The one exported from #Module
+streams# relates to a stream buffer.
+
+
 Generic: buffer-next
 ==============================
 
-A generic function.
+Returns a buffer's "next" mark.
 
 
 Exported from:
 ------------------------------
 - #Module system#
+
+
+Modifiers:
+------------------------------
+sealed
+
+
+Arguments:
+------------------------------
+buf - An instance of #<buffer>#. 
+
+
+Values:
+------------------------------
+next - An instance of #<buffer-index>#. 
+
+
+
+Generic: buffer-next
+==============================
+
+A generic function.
+
+
+Exported from:
+------------------------------
 - #Module streams#
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.c-decl.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.c-decl.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.c-decl.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,8 @@
 Macro: c-decl
 ==============================
 
-A macro.
+Create a global C declaration. If used inside a Dylan function, the
+declaration will be created after the Dylan function in the compiler output.
 
 
 Exported from:
@@ -9,10 +10,14 @@
 - #Module system#
 
 
-Definition:
+Macro call:
 ------------------------------
-:
-          function macro
+: c-decl ( (decl) )
+
+
+Arguments:
+------------------------------
+decl - A literal instance of #<string>#. A global C declaration.
         
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.c-expr.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.c-expr.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.c-expr.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Macro: c-expr
 ==============================
 
-A macro.
+Evaluate a C expression at this point.
 
 
 Exported from:
@@ -9,10 +9,19 @@
 - #Module system#
 
 
-Definition:
+Macro call:
 ------------------------------
-:
-          function macro
-        
+: c-expr ( (type), (expr) )
+
+
+Arguments:
+------------------------------
+type - A literal instance of #<symbol>#. One of the #C type symbols#.
+expr - A literal instance of #<string>#. The C expression to evaluate.
+
+
+Values:
+------------------------------
+result - An instance of #<object>#. The result of _expr_.
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.c-include.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.c-include.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.c-include.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Macro: c-include
 ==============================
 
-A macro.
+Includes a C header file using the "" syntax.
 
 
 Exported from:
@@ -9,10 +9,12 @@
 - #Module system#
 
 
-Definition:
+Macro call:
 ------------------------------
-:
-          function macro
-        
+: c-include ( (file) )
 
 
+Arguments:
+------------------------------        
+file - A literal instance of #<string>#. A C header file.
+

Modified: trunk/documentation/gwydion/gdcore/text/name.c-literal.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.c-literal.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.c-literal.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Macro: c-literal
 ==============================
 
-A macro.
+Returns the Dylan value of a C literal. I cannot fathom a use for this macro.
 
 
 Exported from:
@@ -9,10 +9,16 @@
 - #Module system#
 
 
-Definition:
+Macro call:
 ------------------------------
-:
-          function macro
+: c-literal ( (lit) )
         
 
+Arguments:
+------------------------------
+lit - A literal #<integer># or #<character>#.
+
 
+Values:
+------------------------------
+lit - An #<integer># or #<character>#. The _lit_ argument.

Modified: trunk/documentation/gwydion/gdcore/text/name.c-local-decl.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.c-local-decl.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.c-local-decl.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,8 @@
 Macro: c-local-decl
 ==============================
 
-A macro.
+Create a local C declaration in the current compiler output function. The
+declaration is placed at the beginning of the function.
 
 
 Exported from:
@@ -9,10 +10,11 @@
 - #Module system#
 
 
-Definition:
+Macro call:
 ------------------------------
-:
-          function macro
-        
+: c-local-decl ( (decl) )
 
 
+Arguments:
+------------------------------
+decl - An literal instance of #<string>#. A local C declaration.

Modified: trunk/documentation/gwydion/gdcore/text/name.c-struct-field-setter.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.c-struct-field-setter.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.c-struct-field-setter.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Macro: c-struct-field-setter
 ==============================
 
-A macro.
+Sets the value of a field of a C struct.
 
 
 Exported from:
@@ -9,10 +9,18 @@
 - #Module system#
 
 
-Definition:
+Macro call:
 ------------------------------
-:
-          function macro
+: c-struct-field ( (new-val), (kind), (ptr), (struct), (field) )
+
         
+Arguments:
+------------------------------
+new-val - An instance of #<object>#. The new value for the field.
+kind    - A literal instance of #<symbol>#. One of the #C type symbols#. The
+          C type of the field.
+ptr     - An instance of #<raw-pointer>#. The address of the structure.
+struct  - A literal instance of #<string>#. The name of the C struct type.
+field   - A literal instance of #<string>#. A field of _struct_.
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.c-struct-field.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.c-struct-field.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.c-struct-field.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Macro: c-struct-field
 ==============================
 
-A macro.
+Returns the value of a field of a C structure.
 
 
 Exported from:
@@ -9,10 +9,22 @@
 - #Module system#
 
 
-Definition:
+Macro call:
 ------------------------------
-:
-          function macro
-        
+: c-struct-field ( (kind), (ptr), (struct), (field) )
+
+
+Arguments:
+------------------------------
+kind   - A literal instance of #<symbol>#. One of the #C type symbols#. The
+         C type of the field.
+ptr    - An instance of #<raw-pointer>#. The address of the structure.
+struct - A literal instance of #<string>#. The name of the C struct type.
+field  - A literal instance of #<string>#. A field of _struct_.
+
+
+Values:
+------------------------------
+value - An instance of #<object>#.
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.c-system-include.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.c-system-include.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.c-system-include.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Macro: c-system-include
 ==============================
 
-A macro.
+Includes a C header file using the <> syntax.
 
 
 Exported from:
@@ -9,10 +9,12 @@
 - #Module system#
 
 
-Definition:
+Macro call:
 ------------------------------
-:
-          function macro
-        
+: c-system-include ( (file) )
 
 
+Arguments:
+------------------------------        
+file - A literal instance of #<string>#. A C header file.
+

Modified: trunk/documentation/gwydion/gdcore/text/name.call-out.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.call-out.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.call-out.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,8 @@
 Macro: call-out
 ==============================
 
-A macro.
+Calls a C function and returns its value. The function must have a fixed
+number of arguments; it cannot be variadic (_e.g._ like printf).
 
 
 Exported from:
@@ -9,10 +10,27 @@
 - #Module system#
 
 
-Definition:
+Macro call:
 ------------------------------
-:
-          function macro
-        
+: call-out ( (C-func), (return-type),
+:                      (arg-type), (arg-value),
+:                      (arg-type), (arg-value), ... )
 
 
+Arguments:
+------------------------------
+C-func      - A literal instance of #<string>#, or a #<raw-pointer>#. The name
+              or address of a C function.
+
+return-type - A literal instance of #<symbol>#. One of the #C type symbols#.
+              The C type returned by _C-func_.
+
+arg-type    - A literal instance of #<symbol>#. One of the #C type symbols#.
+              The intended C type of the following _arg-value_.
+
+arg-value   - An instance of #<object>#. An argument for _C-func_.
+
+
+Values:
+------------------------------
+return-value - An instance of #<object>#. The value returned by _C-func_.

Modified: trunk/documentation/gwydion/gdcore/text/name.callback-entry.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.callback-entry.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.callback-entry.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Generic: callback-entry
 ==============================
 
-A generic function.
+Returns the entry point of a C-callable Dylan function.
 
 
 Exported from:
@@ -16,12 +16,13 @@
 
 Arguments:
 ------------------------------
-arg - An instance of #<object>#. 
+callback - A general instance of #<function>#. A C-callable function created
+           by #callback-method#.
 
 
 Values:
 ------------------------------
-#rest more - Instances of #<object>#. 
+address - An instance of #<raw-pointer>#. 
 
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.callback-method.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.callback-method.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.callback-method.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,12 @@
 Macro: callback-method
 ==============================
 
-A macro.
+Creates and returns a C-callable Dylan function. Used like the method statement.
+
+: define constant my-callback =
+:     callback-method (i :: <integer>) => (s :: <string>)
+:       ...
+:     end;
 
 
 Exported from:
@@ -9,10 +14,22 @@
 - #Module system#
 
 
-Definition:
+Macro call:
+------------------------------
+: callback-method (parameters) => (values)
+:   (body)
+: end
+
+
+Arguments:
+------------------------------
+parameters - A parameter list. May be empty.
+values     - A value list. May be empty.
+body       - A method body; a series of semicolon-separated expressions.
+
+
+Values:
 ------------------------------
-:
-          statement macro
-        
+callback - An indirect instance of #<function>#.
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.copy-bytes.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.copy-bytes.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.copy-bytes.txt	Sun Mar  4 03:58:58 2007
@@ -1,12 +1,16 @@
 Generic: copy-bytes
 ==============================
 
-A generic function.
+Copies bytes from one byte collection to another, or copies bytes within a
+byte collection. _Count_ bytes are copied starting from _src-index_ in
+_src-coll_ to _dest-index_ in _dest_coll_. The destination byte range may
+overlap with the source byte range.
 
 
 Exported from:
 ------------------------------
 - #Module system#
+- #Module byte-vector#
 
 
 Modifiers:
@@ -16,37 +20,19 @@
 
 Arguments:
 ------------------------------
-arg - An instance of type-union(<buffer>, <byte-vector>, <unicode-string>, <byte-string>). 
-arg - An instance of #<integer>#. 
-arg - An instance of type-union(<buffer>, <byte-vector>, <unicode-string>, <byte-string>). 
-arg - An instance of #<integer>#. 
-arg - An instance of #<integer>#. 
-
-
-
-Generic: copy-bytes
-==============================
-
-A generic function.
-
-
-Exported from:
-------------------------------
-- #Module byte-vector#
-
-
-Modifiers:
-------------------------------
-open
+dest-coll  - An instance of #<buffer>#, #<byte-vector>#, #<unicode-string>#,
+             or #<byte-string>#.
+             
+dest-index - An instance of #<integer>#.
+
+src-coll   - An instance of #<buffer>#, #<byte-vector>#, #<unicode-string>#,
+             or #<byte-string>#. 
+             
+src-index  - An instance of #<integer>#.
+ 
+count      - An instance of #<integer>#. 
 
 
-Arguments:
+See also:
 ------------------------------
-arg - An instance of #<object>#. 
-arg - An instance of #<object>#. 
-arg - An instance of #<object>#. 
-arg - An instance of #<object>#. 
-arg - An instance of #<object>#. 
-
-
-
+#<buffer-index>#, which is identical to #<integer>#.

Modified: trunk/documentation/gwydion/gdcore/text/name.designator-class-definer.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.designator-class-definer.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.designator-class-definer.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Macro: designator-class-definer
 ==============================
 
-A macro.
+Constructs and returns a #<designator-class>#.
 
 
 Exported from:
@@ -9,10 +9,151 @@
 - #Module system#
 
 
-Definition:
+Macro call:
 ------------------------------
+: define (class-adjectives) designator-class (class-name) ( (superclasses) )
+: options (c-type-options)
+:   (struct-slots)
+:   (slots)
+:   (init-args)
+:   (inherited-slots)
+: end class (class-name)
 :
-          body-style define macro
+: struct-slots:
+:   (struct-adjectives) struct slot (slot-name) :: (slot-type),
+:       (struct-options)
+:
+: slots:
+:   (slot-adjectives) slot (slot-name) :: (slot-type) = (init-expr),
+:       (slot-options)
+:
+: inits-args:
+:   keyword (symbol) (init-expr), (init-arg-options)
+:   required keyword (symbol) = (init-expr), (init-arg-options)
+:
+: inherited-slots:
+:   inherited slot (slot-name) = (init-expr), (inh-slot-options)
         
 
+Arguments:
+------------------------------
+class-adjectives  - Gwydion Dylan allows the following class adjectives:
+                    abstract, concrete, primary, free, sealed, open,
+                    functional, instantiable. These are optional. The defaults
+                    are abstract, primary, sealed, functional, instantiable.
+                    See #Define adjectives# and "Designator class adjectives"
+                    above.
+                  
+class-name        - A binding name.
+                  
+superclasses      - A list of direct superclasses.
+                  
+c-type-options    - This is a list of keys and values. See "Designator class
+                    options" below.
+                    
+struct-adjectives - A series of optional adjectives. See "Struct slot
+                    adjectives" below.
+                    
+struct-options    - This is a list of keys and values. See "Struct slot
+                    options" below.
+                  
+slot-adjectives   - Gwydion Dylan allows the following slot adjectives:
+                    constant, sealed, instance, class, each-subclass, virtual.
+                    See #Define adjectives#.
+                    
+slot-name         - Slot name.
+                  
+slot-type         - Slot type specialization.
+                  
+init-expr         - An expression for the initial value of the slot or init
+                    argument. Optional.
+                  
+symbol            - Keyword symbol.
+                  
+slot-options      - A series of optional keys and values. Keys are
+                    setter:, init-keyword:, required-init-keyword:,
+                    init-value:, init-function:, type:.
+                  
+init-arg-options  - A series of optional keys and values. Keys are
+                    init-value:, init-function:, type:.
+                    
+inh-slot-options  - A series optional of keys and values. Keys are
+                    init-value:, init-function:.
+        
+
+Designator class adjectives:
+------------------------------
+instantiable - The class can be instantiated.
+
+
+Designator class options:
+------------------------------
+These are all optional.
+
+c-name:                  - The C type as a string, for documentation purposes.
+
+referenced-type:         - For pointer types, the C type that the pointer
+                           references. A #<designator-class>#.
+
+pack:                    - For structs, indicates that the struct has the
+                           packing semantics of Microsoft's #pragma pack(n).
+
+c-rep:                   - The C type. One of the #C type symbols#.
+
+import-type:             - A Dylan type conceptually equivalent to the _c-rep_
+                           type. The C type is converted into this type.
+
+export-type:             - A Dylan type conceptually equivalent to the _c-rep_
+                           type. This type is converted into the C type.
+
+import-function:         - A function taking a Dylan object corresponding to
+                           the _c-rep_ C type and returning an instance of
+                           _import-type_.
+
+export-function:         - A function taking an instance of _export-type_ and
+                           returning a Dylan object corresponding to the
+                           _c-rep_ C type.
+
+pointer-type-name:       - For structs, a Dylan variable that will be bound to
+                           the designator class for pointers to the struct.
+
+pointer-type-superclass: - ?
+indirect-getter:         - ?
+indirect-setter:         - ?
+pointer-value-getter-function: - ?
+pointer-value-setter-function: - ?
+
+
+Struct slot adjectives:
+------------------------------
+constant - Prevents a setter method from being created for the slot.
+
+sealed   - Ensures the created setter and getter functions are sealed. [?]
+
+bitmap   - Indicates the slot maps to a C bitfield. The width: option is
+           required. The c-type: option describes the C type of the bitfield,
+           and is one of the #C type symbols#.
+
+array    - Indicates the slot maps to a C array. The dimensions: option is
+           is required. The slot accessors take extra index argument(s).
+
+
+Struct slot options:
+------------------------------
+c-type:         - The field's C type, one of the #C type symbols#. Required.
+setter:         - A generic method to which the slot setter will be added.
+                  Optional. Defaults to slot-name-setter.
+
+address-getter: - A function that can be used to return a pointer to the data
+                  in the C field. It must return a #<raw-pointer># object that
+                  points to a C type. Optional.
+
+c-name:         - The field's C name as a string. Optional.
+
+width:          - The width in bits of a C bitfield.
+
+dimensions:     - The dimension or dimensions of a C array. An integer or a
+                  vector of integers (one integer per axis).
+
+
 

Modified: trunk/documentation/gwydion/gdcore/text/name.environment-variable.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.environment-variable.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.environment-variable.txt	Sun Mar  4 03:58:58 2007
@@ -2,6 +2,7 @@
 ==============================
 
 Returns the value of an environment variable.
+Equivalent but not identical to #getenv#.
 
 
 Exported from:

Modified: trunk/documentation/gwydion/gdcore/text/name.export-string.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.export-string.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.export-string.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Function: export-string
 ==============================
 
-A function.
+Returns a C string from a Dylan string.
 
 
 Exported from:
@@ -11,12 +11,12 @@
 
 Arguments:
 ------------------------------
-arg - An instance of #<byte-string>#. 
+dylan-string - An instance of #<byte-string>#. 
 
 
 Values:
 ------------------------------
-val - An instance of #<raw-pointer>#. 
+c-string - An instance of #<raw-pointer>#. 
 
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.get-time-of-day.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.get-time-of-day.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.get-time-of-day.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,8 @@
 Function: get-time-of-day
 ==============================
 
-A function.
+Returns the number of seconds that have passed since 00:00:00 GMT January 1,
+1970.
 
 
 Exported from:
@@ -11,7 +12,7 @@
 
 Values:
 ------------------------------
-val - An instance of #<integer>#. 
+seconds - An instance of #<integer>#. 
 
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.getenv.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.getenv.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.getenv.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,8 @@
 Function: getenv
 ==============================
 
-A function.
+Returns the value of an environment variable using the C getenv function.
+Equivalent but not identical to #environment-variable#.
 
 
 Exported from:
@@ -11,12 +12,14 @@
 
 Arguments:
 ------------------------------
-arg - An instance of #<byte-string>#. 
+variable - An instance of #<byte-string>#. The name of an environment
+           variable.
 
 
 Values:
 ------------------------------
-val - An instance of type-union(<false>, <byte-string>). 
+value - An instance of #<byte-string>#, or #f if _variable_ is not defined in
+        the environment.
 
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.import-string.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.import-string.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.import-string.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Function: import-string
 ==============================
 
-A function.
+Returns a Dylan string from a C string.
 
 
 Exported from:
@@ -11,12 +11,12 @@
 
 Arguments:
 ------------------------------
-arg - An instance of #<raw-pointer>#. 
+c-string - An instance of #<raw-pointer>#. 
 
 
 Values:
 ------------------------------
-val - An instance of #<byte-string>#. 
+dylan-string - An instance of #<byte-string>#. 
 
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.no-core-dumps.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.no-core-dumps.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.no-core-dumps.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Function: no-core-dumps
 ==============================
 
-A function.
+On Unix operating systems, prevents core dump files.
 
 
 Exported from:

Modified: trunk/documentation/gwydion/gdcore/text/name.pointer-deref-setter.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.pointer-deref-setter.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.pointer-deref-setter.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Macro: pointer-deref-setter
 ==============================
 
-A macro.
+Sets the C value that a #<raw-pointer># points to.
 
 
 Exported from:
@@ -9,10 +9,19 @@
 - #Module system#
 
 
-Definition:
+Macro call:
 ------------------------------
-:
-          function macro
+: pointer-deref-setter ( (new-val), (kind), (ptr), (offset) )
         
 
+Arguments:
+------------------------------
+new-val - An instance of #<object>#. The value to set at _ptr_ + _offset_.
+
+kind    - A literal #<symbol>#, one of the #C type symbols#. The C type
+          expected at _ptr_ + _offset_.
+
+ptr     - An instance of #<raw-pointer>#.
+
+offset  - An instance of #<integer>#. A byte offset from the _ptr_ address.
 

Modified: trunk/documentation/gwydion/gdcore/text/name.pointer-deref.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.pointer-deref.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.pointer-deref.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Macro: pointer-deref
 ==============================
 
-A macro.
+Returns the C value that a #<raw-pointer># points to.
 
 
 Exported from:
@@ -9,10 +9,21 @@
 - #Module system#
 
 
-Definition:
+Macro call:
 ------------------------------
-:
-          function macro
+: pointer-deref ( (kind), (ptr), (offset) )
         
 
+Arguments:
+------------------------------
+kind   - A literal #<symbol>#, one of the #C type symbols#. The C type found
+         at _ptr_ + _offset_.
+         
+ptr    - An instance of #<raw-pointer>#.
+
+offset - An instance of #<integer>#. A byte offset from the _ptr_ address.
 
+
+Values:
+------------------------------
+value - An instance of #<object>#.

Modified: trunk/documentation/gwydion/gdcore/text/name.referenced-type.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.referenced-type.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.referenced-type.txt	Sun Mar  4 03:58:58 2007
@@ -1,8 +1,7 @@
 Generic: referenced-type
 ==============================
 
-A generic function.
-
+Returns the designator class that a pointer's designator class points to.
 
 Exported from:
 ------------------------------
@@ -16,12 +15,14 @@
 
 Arguments:
 ------------------------------
-arg - An instance of #<object>#. 
+pointer-class - An instance of #<designator-class>#. 
 
 
 Values:
 ------------------------------
-#rest more - Instances of #<object>#. 
+deref'd-pointer-class - An instance of #<designator-class># or #f if
+                        _pointer-class_ is not the designator class for a
+                        pointer type. 
 
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.run-application.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.run-application.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.run-application.txt	Sun Mar  4 03:58:58 2007
@@ -2,7 +2,8 @@
 ==============================
 
 Runs an application in a separate process. Under Windows, the application's
-output may be retrieved piecemeal via the _outputter_ argument.
+output may be retrieved piecemeal via the _outputter_ argument. Under Unix,
+equivalent but not identical to #system#.
 
 The _outputter_ argument is a function with the signature
 (buffer :: #<byte-string>#, end: :: #<integer>#) => ().

Modified: trunk/documentation/gwydion/gdcore/text/name.size-of.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.size-of.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.size-of.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Generic: size-of
 ==============================
 
-A generic function.
+Returns the size of a C type in sizeof units.
 
 
 Exported from:
@@ -16,12 +16,12 @@
 
 Arguments:
 ------------------------------
-arg - An instance of #<object>#. 
+c-type - An instance of #<designator-class>#.
 
 
 Values:
 ------------------------------
-#rest more - Instances of #<object>#. 
+size - An instance of #<integer>#.
 
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.system.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.system.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.system.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,8 @@
 Function: system
 ==============================
 
-A function.
+Runs an application or command. Equivalent but not identical to
+#run-application# on Unix platforms.
 
 
 Exported from:
@@ -11,12 +12,12 @@
 
 Arguments:
 ------------------------------
-arg - An instance of #<byte-string>#. 
+command - An instance of #<byte-string>#. The command to run.
 
 
 Values:
 ------------------------------
-val - An instance of #<integer>#. 
+exit-code - An instance of #<integer>#. The command's exit code.
 
 
 

Modified: trunk/documentation/gwydion/gdcore/text/name.vector-elements-address.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.vector-elements-address.txt	(original)
+++ trunk/documentation/gwydion/gdcore/text/name.vector-elements-address.txt	Sun Mar  4 03:58:58 2007
@@ -1,7 +1,7 @@
 Generic: vector-elements-address
 ==============================
 
-A generic function.
+Returns the address at which a #<vector>#'s elements begin.
 
 
 Exported from:
@@ -16,12 +16,12 @@
 
 Arguments:
 ------------------------------
-arg - An instance of #<object>#. 
+vec - An instance of #<vector>#. 
 
 
 Values:
 ------------------------------
-#rest more - Instances of #<object>#. 
+addr - An instance of #<raw-pointer>#. 
 
 
 



More information about the chatter mailing list