logo       
Google Custom Search
    AddThis Social Bookmark Button

r10707 - in trunk/documentation/topic/reference/lib: . common-dylan/common-: msg#00107

Subject: r10707 - in trunk/documentation/topic/reference/lib: . common-dylan/common-extensions io/format io/streams network/sockets system/operating-system
Author: housel
Date: Sat Apr 29 07:37:56 2006
New Revision: 10707

Modified:
   trunk/documentation/topic/reference/lib/c-ffi.xml
   
trunk/documentation/topic/reference/lib/common-dylan/common-extensions/Dunfound.xml
   trunk/documentation/topic/reference/lib/io/format/format.xml
   trunk/documentation/topic/reference/lib/io/streams/LbufferG.xml
   trunk/documentation/topic/reference/lib/network/sockets/Dlocal_host.xml
   trunk/documentation/topic/reference/lib/network/sockets/Dloopback_address.xml
   trunk/documentation/topic/reference/lib/network/sockets/Labstract_socketG.xml
   trunk/documentation/topic/reference/lib/network/sockets/Laddress_in_useG.xml
   
trunk/documentation/topic/reference/lib/network/sockets/Lblocking_call_interruptedG.xml
   
trunk/documentation/topic/reference/lib/system/operating-system/Dmachine_name.xml
   trunk/documentation/topic/reference/lib/system/operating-system/Dos_name.xml
   
trunk/documentation/topic/reference/lib/system/operating-system/Dos_variant.xml
   
trunk/documentation/topic/reference/lib/system/operating-system/Dos_version.xml
   
trunk/documentation/topic/reference/lib/system/operating-system/Dplatform_name.xml
Log:
Bug: 7249
- Another batch of API reference text updates adapted from FrameMaker sources.


Modified: trunk/documentation/topic/reference/lib/c-ffi.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/c-ffi.xml   (original)
+++ trunk/documentation/topic/reference/lib/c-ffi.xml   Sat Apr 29 07:37:56 2006
@@ -14,7 +14,24 @@
 
   <dylanLibraryDetail>
     <apiDesc>
-      <p></p>
+      <p>The C-FFI library provides a set of macros that can be used
+      to describe a C interface in a form that the the Dylan compiler
+      can understand; we call these macros the <term>C interface
+      definition language</term>.</p>
+
+      <p>The C interface definition language provides macros that
+      correspond to each of C’s type, function, variable, and constant
+      defining forms.  These macros define Dylan classes that
+      designate and encapsulate instances of C types, Dylan methods
+      through which to manipulate C variables and call out to C
+      functions, and functions with C-compatible entry points through
+      which to call in to Dylan from C.</p>
+
+      <p>In addition to the interface definition language, the C-FFI
+      library provides run-time methods and functions for allocating,
+      manipulating and destroying instances of C data structures. For
+      example, using these facilities you can allocate C structs and
+      arrays, and access and set their elements.</p>
     </apiDesc>
   </dylanLibraryDetail>
 

Modified: 
trunk/documentation/topic/reference/lib/common-dylan/common-extensions/Dunfound.xml
==============================================================================
--- 
trunk/documentation/topic/reference/lib/common-dylan/common-extensions/Dunfound.xml
 (original)
+++ 
trunk/documentation/topic/reference/lib/common-dylan/common-extensions/Dunfound.xml
 Sat Apr 29 07:37:56 2006
@@ -20,8 +20,9 @@
     </dylanConstantDef>
 
     <apiDesc>
-      <p>A unique value that can be used to indicate that a search operation
-      failed.</p>
+      <p>The <apivalue>$unfound</apivalue> constant represents a
+      unique value that can be used to indicate that a search
+      operation failed.</p>
     </apiDesc>
   </dylanConstantDetail>
 </dylanConstant>

Modified: trunk/documentation/topic/reference/lib/io/format/format.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/io/format/format.xml        
(original)
+++ trunk/documentation/topic/reference/lib/io/format/format.xml        Sat Apr 
29 07:37:56 2006
@@ -17,7 +17,8 @@
       <dylanFunctionParam>
        <apiItemName>stream</apiItemName>
         <apiOperationClassifier 
href="../../common-dylan/streams-protocol/LstreamG.xml">&lt;stream&gt;</apiOperationClassifier>
-       <apiDefNote></apiDefNote>
+       <apiDefNote>The stream
+          to which formatted output should be sent</apiDefNote>
       </dylanFunctionParam>
       <dylanFunctionParam>
        <apiItemName>control-string</apiItemName>

Modified: trunk/documentation/topic/reference/lib/io/streams/LbufferG.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/io/streams/LbufferG.xml     
(original)
+++ trunk/documentation/topic/reference/lib/io/streams/LbufferG.xml     Sat Apr 
29 07:37:56 2006
@@ -2,7 +2,9 @@
 <!DOCTYPE dylanClass PUBLIC "-//Gwydion//DTD DITA Dylan API Class//EN" 
"../../../../dtd/dylanClass.dtd" []>
 <dylanClass id="lib-io-streams-LbufferG">
   <apiName>&lt;buffer&gt;</apiName>
-  <shortdesc>The class of .</shortdesc>
+
+  <shortdesc>The class of vectors of <apiname>&lt;byte&gt;</apiname>,
+  usable as stream buffers.</shortdesc>
 
   <prolog>
     <author></author>
@@ -59,7 +61,27 @@
     </dylanClassDef>
 
     <apiDesc>
-      <p></p>
+      <p>The <apiname>&lt;buffer&gt;</apiname> class is a subclass of
+      <apiname>&lt;vector&gt;</apiname> whose
+      <apiname>element-type</apiname> is
+      <apiname>&lt;byte&gt;</apiname>.</p>
+
+      <p>Instances of <apiname>&lt;buffer&gt;</apiname>  contain a data vector
+      and two indices: the inclusive start and the exclusive end of valid
+      data in the buffer. The accessors for these indexes are called 
+      <apiname>buffer-next</apiname>  and <apiname>buffer-end</apiname>.</p>
+
+      <p>Note that <codeph>size:</codeph> is not taken as a suggestion
+      of the size the user would like, as with the value passed with
+      <codeph>buffer-size:</codeph> to <apiname>make</apiname> on
+      <apiname>&lt;buffered-stream&gt;</apiname>; if you supply a
+      value with the <codeph>size:</codeph> init-keyword, that size is
+      allocated, or, if that is not possible, an error is signalled,
+      as with making any vector.</p>
+
+      <!-- COMMENT: What is the error? The error on &lt;vector&gt;? BC
+        says: "Not specified, but if the DRM specifies one, ours
+        should be the same."  -->
     </apiDesc>
   </dylanClassDetail>
 </dylanClass>

Modified: 
trunk/documentation/topic/reference/lib/network/sockets/Dlocal_host.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/network/sockets/Dlocal_host.xml     
(original)
+++ trunk/documentation/topic/reference/lib/network/sockets/Dlocal_host.xml     
Sat Apr 29 07:37:56 2006
@@ -14,11 +14,24 @@
 
   <dylanVariableDetail>
     <dylanVariableDef>
-      <apiType value="{complex type}"/>
+      <apiValueClassifier 
href="Linternet_addressG.xml">&lt;internet-address&gt;</apiValueClassifier>
     </dylanVariableDef>
 
     <apiDesc>
-      <p></p>
+      <p>An instance of
+      <apiclassifier>&lt;internet-address&gt;</apiclassifier>
+      representing the host on which the application using sockets is
+      correctly running.</p>
+
+      <p>Note that this value is not necessarily the same as would be
+      created by the expression</p>
+
+      <codeblock>make (&lt;internet-address&gt;, name: "localhost")</codeblock>
+
+      <p>The address assigned to the symbolic name
+      <codeph>localhost</codeph> is dependent on the configuration of
+      DNS. In some cases this may be configured to be the loopback
+      address rather than a real address for the local host.</p>
     </apiDesc>
   </dylanVariableDetail>
 </dylanVariable>

Modified: 
trunk/documentation/topic/reference/lib/network/sockets/Dloopback_address.xml
==============================================================================
--- 
trunk/documentation/topic/reference/lib/network/sockets/Dloopback_address.xml   
    (original)
+++ 
trunk/documentation/topic/reference/lib/network/sockets/Dloopback_address.xml   
    Sat Apr 29 07:37:56 2006
@@ -14,11 +14,12 @@
 
   <dylanVariableDetail>
     <dylanVariableDef>
-      <apiType value="{complex type}"/>
+      <apiValueClassifier 
href="Linternet_addressG.xml">&lt;internet-address&gt;</apiValueClassifier>
     </dylanVariableDef>
 
     <apiDesc>
-      <p></p>
+      <p>An instance of <codeph>&lt;internet-address&gt;</codeph>  representing
+      the loopback address: <codeph>127.0.0.1</codeph> .</p>
     </apiDesc>
   </dylanVariableDetail>
 </dylanVariable>

Modified: 
trunk/documentation/topic/reference/lib/network/sockets/Labstract_socketG.xml
==============================================================================
--- 
trunk/documentation/topic/reference/lib/network/sockets/Labstract_socketG.xml   
    (original)
+++ 
trunk/documentation/topic/reference/lib/network/sockets/Labstract_socketG.xml   
    Sat Apr 29 07:37:56 2006
@@ -2,7 +2,8 @@
 <!DOCTYPE dylanClass PUBLIC "-//Gwydion//DTD DITA Dylan API Class//EN" 
"../../../../dtd/dylanClass.dtd" []>
 <dylanClass id="lib-network-sockets-Labstract_socketG">
   <apiName>&lt;abstract-socket&gt;</apiName>
-  <shortdesc>The class of .</shortdesc>
+
+  <shortdesc>The class of of all socket objects.</shortdesc>
 
   <prolog>
     <author></author>
@@ -25,7 +26,11 @@
     </dylanClassDef>
 
     <apiDesc>
-      <p></p>
+      <p>The <apiname>&lt;abstract-socket&gt;</apiname> class serves
+      as the common superclass of all socket objects including
+      <apiname>&lt;socket&gt;</apiname> (IP client socket),
+      <apiname>&lt;server-socket&gt;</apiname> and
+      <apiname>&lt;socket-accessor&gt;</apiname>.</p>
     </apiDesc>
   </dylanClassDetail>
 </dylanClass>

Modified: 
trunk/documentation/topic/reference/lib/network/sockets/Laddress_in_useG.xml
==============================================================================
--- 
trunk/documentation/topic/reference/lib/network/sockets/Laddress_in_useG.xml    
    (original)
+++ 
trunk/documentation/topic/reference/lib/network/sockets/Laddress_in_useG.xml    
    Sat Apr 29 07:37:56 2006
@@ -2,7 +2,9 @@
 <!DOCTYPE dylanClass PUBLIC "-//Gwydion//DTD DITA Dylan API Class//EN" 
"../../../../dtd/dylanClass.dtd" []>
 <dylanClass id="lib-network-sockets-Laddress_in_useG">
   <apiName>&lt;address-in-use&gt;</apiName>
-  <shortdesc>The class of .</shortdesc>
+
+  <shortdesc>The class of conditions signalled when a socket address
+  is already in use.</shortdesc>
 
   <prolog>
     <author></author>
@@ -29,7 +31,12 @@
     </dylanClassDef>
 
     <apiDesc>
-      <p></p>
+      <p>The <apiname>&lt;address-in-use&gt;</apiname> condition is
+      signalled when a process on the machine is already bound to the
+      same fully qualified address. This condition probably occurred
+      because you were trying to use a port with an active server
+      already installed, or a process crashed without closing a
+      socket.</p>
     </apiDesc>
   </dylanClassDetail>
 </dylanClass>

Modified: 
trunk/documentation/topic/reference/lib/network/sockets/Lblocking_call_interruptedG.xml
==============================================================================
--- 
trunk/documentation/topic/reference/lib/network/sockets/Lblocking_call_interruptedG.xml
     (original)
+++ 
trunk/documentation/topic/reference/lib/network/sockets/Lblocking_call_interruptedG.xml
     Sat Apr 29 07:37:56 2006
@@ -2,7 +2,9 @@
 <!DOCTYPE dylanClass PUBLIC "-//Gwydion//DTD DITA Dylan API Class//EN" 
"../../../../dtd/dylanClass.dtd" []>
 <dylanClass id="lib-network-sockets-Lblocking_call_interruptedG">
   <apiName>&lt;blocking-call-interrupted&gt;</apiName>
-  <shortdesc>The class of .</shortdesc>
+
+  <shortdesc>The class of error conditions signalled when a blocking
+  socket call was interrupted.</shortdesc>
 
   <prolog>
     <author></author>
@@ -19,7 +21,10 @@
     </dylanClassDef>
 
     <apiDesc>
-      <p></p>
+      <p>The <apiname>L&lt;blocking-call-interrupted&gt;</apiname> is
+      signalled when a blocking socket call, like
+      <apiname>read</apiname>, <apiname>write</apiname> or
+      <apiname>accept</apiname>, was interrupted.</p>
     </apiDesc>
   </dylanClassDetail>
 </dylanClass>

Modified: 
trunk/documentation/topic/reference/lib/system/operating-system/Dmachine_name.xml
==============================================================================
--- 
trunk/documentation/topic/reference/lib/system/operating-system/Dmachine_name.xml
   (original)
+++ 
trunk/documentation/topic/reference/lib/system/operating-system/Dmachine_name.xml
   Sat Apr 29 07:37:56 2006
@@ -2,7 +2,9 @@
 <!DOCTYPE dylanConstant PUBLIC "-//Gwydion//DTD DITA Dylan API Constant//EN" 
"../../../../dtd/dylanConstant.dtd" []>
 <dylanConstant id="lib-system-operating-system-Dmachine_name">
   <apiName>$machine-name</apiName>
-  <shortdesc></shortdesc>
+
+  <shortdesc>Constant specifying the type of hardware installed in the
+  host.</shortdesc>
 
   <prolog>
     <author></author>
@@ -14,11 +16,65 @@
 
   <dylanConstantDetail>
     <dylanConstantDef>
-      <apiValueClassifier 
href="../../dylan/dylan/LobjectG.xml">&lt;object&gt;</apiValueClassifier>
+      <apiValueClassifier 
href="../../dylan/dylan/LsymbolG.xml">&lt;symbol&gt;</apiValueClassifier>
     </dylanConstantDef>
 
     <apiDesc>
-      <p></p>
+      <p>This constant is a symbol that represents the type of
+      central processor installed in the host machine.</p>
+
+      <p>The following values are defined for this constant.</p>
+
+      <dl>
+       <dlentry>
+         <dt><codeph>#"x86"</codeph></dt>
+         <dd>Intel IA-32 architecture processors</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"x86-64"</codeph></dt>
+         <dd>AMD Opteron and Intel EM64T architecture processors.</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"sparc"</codeph></dt>
+         <dd>Sun Sparc processors.</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"ppc"</codeph></dt>
+         <dd>Motorola/IBM PowerPC processors.</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"arm"</codeph></dt>
+         <dd>ARM processors.</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"mips"</codeph></dt>
+         <dd>MIPS processors.</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"alpha"</codeph></dt>
+         <dd>Alpha processors.</dd>
+       </dlentry>
     </apiDesc>
   </dylanConstantDetail>
+
+  <related-links>
+    <link href="Dos_name.xml">
+      <linktext><apiname>$os-name</apiname></linktext>
+    </link>
+    <link href="Dos_variant.xml">
+      <linktext><apiname>$os-variant</apiname></linktext>
+    </link>
+    <link href="Dos_version.xml">
+      <linktext><apiname>$os-version</apiname></linktext>
+    </link>
+    <link href="Dplatform_name.xml">
+      <linktext><apiname>$platform-name</apiname></linktext>
+    </link>
+  </related-links>
 </dylanConstant>

Modified: 
trunk/documentation/topic/reference/lib/system/operating-system/Dos_name.xml
==============================================================================
--- 
trunk/documentation/topic/reference/lib/system/operating-system/Dos_name.xml    
    (original)
+++ 
trunk/documentation/topic/reference/lib/system/operating-system/Dos_name.xml    
    Sat Apr 29 07:37:56 2006
@@ -2,7 +2,9 @@
 <!DOCTYPE dylanConstant PUBLIC "-//Gwydion//DTD DITA Dylan API Constant//EN" 
"../../../../dtd/dylanConstant.dtd" []>
 <dylanConstant id="lib-system-operating-system-Dos_name">
   <apiName>$os-name</apiName>
-  <shortdesc></shortdesc>
+
+  <shortdesc>Constant specifying the operating system running on the
+  host machine.</shortdesc>
 
   <prolog>
     <author></author>
@@ -14,11 +16,59 @@
 
   <dylanConstantDetail>
     <dylanConstantDef>
-      <apiValueClassifier 
href="../../dylan/dylan/LobjectG.xml">&lt;object&gt;</apiValueClassifier>
+      <apiValueClassifier 
href="../../dylan/dylan/LsymbolG.xml">&lt;symbol&gt;</apiValueClassifier>
     </dylanConstantDef>
 
     <apiDesc>
-      <p></p>
+      <p>This constant is a symbol that represents the operating system
+      running on the host machine.</p>
+
+      <dl>
+       <dlentry>
+         <dt><codeph>#"win32"</codeph></dt>
+         <dd>The Microsoft Win32 operating system platform.</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"linux"</codeph></dt>
+         <dd>The Linux kernel.</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"freebsd"</codeph></dt>
+         <dd>The FreeBSD operating system.</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"netbsd"</codeph></dt>
+         <dd>The NetBSD operating system.</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"darwin"</codeph></dt>
+         <dd>The Darwin (Mac OS X) operating system.</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"sunos"</codeph></dt>
+         <dd>The Solaris operating system.</dd>
+       </dlentry>
+      </dl>
     </apiDesc>
   </dylanConstantDetail>
+
+  <related-links>
+    <link href="Dmachine_name.xml">
+      <linktext><apiname>$machine-name</apiname></linktext>
+    </link>
+    <link href="Dos_variant.xml">
+      <linktext><apiname>$os-variant</apiname></linktext>
+    </link>
+    <link href="Dos_version.xml">
+      <linktext><apiname>$os-version</apiname></linktext>
+    </link>
+    <link href="Dplatform_name.xml">
+      <linktext><apiname>$platform-name</apiname></linktext>
+    </link>
+  </related-links>
 </dylanConstant>

Modified: 
trunk/documentation/topic/reference/lib/system/operating-system/Dos_variant.xml
==============================================================================
--- 
trunk/documentation/topic/reference/lib/system/operating-system/Dos_variant.xml 
    (original)
+++ 
trunk/documentation/topic/reference/lib/system/operating-system/Dos_variant.xml 
    Sat Apr 29 07:37:56 2006
@@ -2,7 +2,9 @@
 <!DOCTYPE dylanConstant PUBLIC "-//Gwydion//DTD DITA Dylan API Constant//EN" 
"../../../../dtd/dylanConstant.dtd" []>
 <dylanConstant id="lib-system-operating-system-Dos_variant">
   <apiName>$os-variant</apiName>
-  <shortdesc></shortdesc>
+
+  <shortdesc>Constant specifying which variant of an operating system
+  the current machine is running, where relevant.</shortdesc>
 
   <prolog>
     <author></author>
@@ -14,11 +16,70 @@
 
   <dylanConstantDetail>
     <dylanConstantDef>
-      <apiValueClassifier 
href="../../dylan/dylan/LobjectG.xml">&lt;object&gt;</apiValueClassifier>
+      <apiValueClassifier 
href="../../dylan/dylan/LsymbolG.xml">&lt;symbol&gt;</apiValueClassifier>
     </dylanConstantDef>
 
     <apiDesc>
-      <p></p>
+      <p>This constant is a symbol value distinguishing between
+      variants of the operating system identified by
+      <apiname>$os-name</apiname>, where relevant; otherwise it has
+      the same value as <apiname>$os-name</apiname>.</p>
+
+      <p>On Windows, the possible values are:
+      <codeph>#"win3.1"</codeph>, <codeph>#"win95"</codeph>,
+      <codeph>#"win98"</codeph>, and <codeph>#"winnt"</codeph>.</p>
+
+      <dl>
+       <dlentry>
+         <dt><codeph>#"win3.1"</codeph></dt>
+         <dd>Windows 3.1 (via Win32s)</dd>
+       </dlentry>
+       
+       <dlentry>
+         <dt><codeph>#"win95"</codeph></dt>
+         <dd>Windows 95</dd>
+       </dlentry>
+       
+       <dlentry>
+         <dt><codeph>#"win98"</codeph></dt>
+         <dd>Windows 98</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"winme"</codeph></dt>
+         <dd>Windows ME</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"winnt"</codeph></dt>
+         <dd>Windows NT 4.x</dd>
+       </dlentry>
+       
+       <dlentry>
+         <dt><codeph>#"win2000"</codeph></dt>
+         <dd>Windows 2000</dd>
+       </dlentry>
+
+       <dlentry>
+         <dt><codeph>#"winxp"</codeph></dt>
+         <dd>Windows XP</dd>
+       </dlentry>
+      </dl>
     </apiDesc>
   </dylanConstantDetail>
+
+  <related-links>
+    <link href="Dmachine_name.xml">
+      <linktext><apiname>$machine-name</apiname></linktext>
+    </link>
+    <link href="Dos_name.xml">
+      <linktext><apiname>$os-name</apiname></linktext>
+    </link>
+    <link href="Dos_version.xml">
+      <linktext><apiname>$os-version</apiname></linktext>
+    </link>
+    <link href="Dplatform_name.xml">
+      <linktext><apiname>$platform-name</apiname></linktext>
+    </link>
+  </related-links>
 </dylanConstant>

Modified: 
trunk/documentation/topic/reference/lib/system/operating-system/Dos_version.xml
==============================================================================
--- 
trunk/documentation/topic/reference/lib/system/operating-system/Dos_version.xml 
    (original)
+++ 
trunk/documentation/topic/reference/lib/system/operating-system/Dos_version.xml 
    Sat Apr 29 07:37:56 2006
@@ -2,7 +2,9 @@
 <!DOCTYPE dylanConstant PUBLIC "-//Gwydion//DTD DITA Dylan API Constant//EN" 
"../../../../dtd/dylanConstant.dtd" []>
 <dylanConstant id="lib-system-operating-system-Dos_version">
   <apiName>$os-version</apiName>
-  <shortdesc></shortdesc>
+
+  <shortdesc>Constant specifying which version of an operating system
+  the current machine is running.</shortdesc>
 
   <prolog>
     <author></author>
@@ -14,11 +16,30 @@
 
   <dylanConstantDetail>
     <dylanConstantDef>
-      <apiValueClassifier 
href="../../dylan/dylan/LobjectG.xml">&lt;object&gt;</apiValueClassifier>
+      <apiValueClassifier 
href="../../dylan/dylan/LstringG.xml">&lt;string&gt;</apiValueClassifier>
     </dylanConstantDef>
 
     <apiDesc>
-      <p></p>
+      <p>The constant <codeph>$os-version</codeph> is a string value
+      that identifies the version of the operating system.  For
+      Windows NT, a typical value would be <codeph>"4.0.1381 Service
+      Pack 3"</codeph>. For Windows 95, a typical value would be
+      <codeph>"4.0.1212 B"</codeph>.</p>
     </apiDesc>
   </dylanConstantDetail>
+
+  <related-links>
+    <link href="Dmachine_name.xml">
+      <linktext><apiname>$machine-name</apiname></linktext>
+    </link>
+    <link href="Dos_name.xml">
+      <linktext><apiname>$os-name</apiname></linktext>
+    </link>
+    <link href="Dos_variant.xml">
+      <linktext><apiname>$os-variant</apiname></linktext>
+    </link>
+    <link href="Dplatform_name.xml">
+      <linktext><apiname>$platform-name</apiname></linktext>
+    </link>
+  </related-links>
 </dylanConstant>

Modified: 
trunk/documentation/topic/reference/lib/system/operating-system/Dplatform_name.xml
==============================================================================
--- 
trunk/documentation/topic/reference/lib/system/operating-system/Dplatform_name.xml
  (original)
+++ 
trunk/documentation/topic/reference/lib/system/operating-system/Dplatform_name.xml
  Sat Apr 29 07:37:56 2006
@@ -2,7 +2,9 @@
 <!DOCTYPE dylanConstant PUBLIC "-//Gwydion//DTD DITA Dylan API Constant//EN" 
"../../../../dtd/dylanConstant.dtd" []>
 <dylanConstant id="lib-system-operating-system-Dplatform_name">
   <apiName>$platform-name</apiName>
-  <shortdesc></shortdesc>
+
+  <shortdesc>Constant specifying the operating system running on and
+  the type of hardware installed in the host machine.</shortdesc>
 
   <prolog>
     <author></author>
@@ -14,11 +16,30 @@
 
   <dylanConstantDetail>
     <dylanConstantDef>
-      <apiValueClassifier 
href="../../dylan/dylan/LobjectG.xml">&lt;object&gt;</apiValueClassifier>
+      <apiValueClassifier 
href="../../dylan/dylan/LsymbolG.xml">&lt;symbol&gt;</apiValueClassifier>
     </dylanConstantDef>
 
     <apiDesc>
-      <p></p>
+      <p>This constant is a symbol that represents the both the
+      operating system running on, and the type of hardware installed
+      in, the host machine. It is a combination of the
+      <apiname>$os-name</apiname> and <apiname>$machine-name</apiname>
+      constants.</p>
     </apiDesc>
   </dylanConstantDetail>
+
+  <related-links>
+    <link href="Dos_name.xml">
+      <linktext><apiname>$os-name</apiname></linktext>
+    </link>
+    <link href="Dmachine_name.xml">
+      <linktext><apiname>$machine-name</apiname></linktext>
+    </link>
+    <link href="Dos_variant.xml">
+      <linktext><apiname>$os-variant</apiname></linktext>
+    </link>
+    <link href="Dos_version.xml">
+      <linktext><apiname>$os-version</apiname></linktext>
+    </link>
+  </related-links>
 </dylanConstant>
-- 
Gd-chatter mailing list
Gd-chatter@xxxxxxxxxxxxxxxx
https://www.gwydiondylan.org/mailman/listinfo/gd-chatter

Try Searching:
servers, voip, java, networking, microsoft ...
<Prev in Thread] Current Thread [Next in Thread>