Author: housel
Date: Wed Jun 7 06:47:21 2006
New Revision: 10787
Added:
trunk/documentation/topic/map/reference/threads-basic-features.xml
(contents, props changed)
trunk/documentation/topic/reference/lib/common-dylan/threads/threads-class-hierarchy.svg
(contents, props changed)
trunk/documentation/topic/reference/lib/common-dylan/threads/threads-class-hierarchy.xml
(contents, props changed)
Modified:
trunk/documentation/topic/map/reference/threads.ditamap
trunk/documentation/topic/reference/lib/common-dylan/threads.xml
trunk/documentation/topic/reference/lib/common-dylan/threads/LnotificationG.xml
trunk/documentation/topic/reference/lib/common-dylan/threads/LthreadG.xml
Log:
Bug: 7249
Updates to the documentation of the threads module.
Added: trunk/documentation/topic/map/reference/threads-basic-features.xml
==============================================================================
--- (empty file)
+++ trunk/documentation/topic/map/reference/threads-basic-features.xml Wed Jun
7 06:47:21 2006
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "../dtd/map.dtd">
+<topic id="threads-basic-features">
+ <title>Basic Threading Features</title>
+
+ <body>
+ <p>This section documents basic features of the Threads library: operations
+ on threads and low-level synchronization.</p>
+ </body>
+</topic>
Modified: trunk/documentation/topic/map/reference/threads.ditamap
==============================================================================
--- trunk/documentation/topic/map/reference/threads.ditamap (original)
+++ trunk/documentation/topic/map/reference/threads.ditamap Wed Jun 7
06:47:21 2006
@@ -15,4 +15,63 @@
<topicref href="../../concept/threads/thread-safety-general.xml" />
<topicref href="../../concept/threads/thread-safety-dylan.xml" />
</topicref>
+ <topicref
href="../../reference/lib/common-dylan/threads/threads-class-hierarchy.xml" />
+ <topicref href="threads-basic-features.xml">
+ <topicref navtitle="Low-level synchronization">
+ <topicref
href="../../reference/lib/common-dylan/threads/sequence_point.xml"/>
+ <topicref
href="../../reference/lib/common-dylan/threads/synchronize_side_effects.xml"/>
+ </topicref>
+ <topicref navtitle="Operations on threads">
+ <topicref href="../../reference/lib/common-dylan/threads/LthreadG.xml"/>
+ <topicref
href="../../reference/lib/common-dylan/threads/thread_name.xml"/>
+ <topicref
href="../../reference/lib/common-dylan/threads/join_thread.xml"/>
+ <topicref
href="../../reference/lib/common-dylan/threads/thread_yield.xml"/>
+ <topicref
href="../../reference/lib/common-dylan/threads/current_thread.xml"/>
+ </topicref>
+ </topicref>
+ <topicref navtitle="Synchronization protocol">
+ <topicref navtitle="Basic features">
+ <topicref
href="../../reference/lib/common-dylan/threads/LsynchronizationG.xml"/>
+ <topicref href="../../reference/lib/common-dylan/threads/wait_for.xml"/>
+ <topicref href="../../reference/lib/common-dylan/threads/release.xml"/>
+ <topicref
href="../../reference/lib/common-dylan/threads/synchronization_name.xml"/>
+ </topicref>
+ <topicref navtitle="Locks">
+ <topicref href="../../reference/lib/common-dylan/threads/LlockG.xml"/>
+ <topicref href="../../reference/lib/common-dylan/threads/with_lock.xml"/>
+ </topicref>
+ <topicref navtitle="Semaphores">
+ <topicref
href="../../reference/lib/common-dylan/threads/LsemaphoreG.xml"/>
+ </topicref>
+ <topicref navtitle="Exclusive locks">
+ <topicref
href="../../reference/lib/common-dylan/threads/Lexclusive_lockG.xml"/>
+ <topicref href="../../reference/lib/common-dylan/threads/ownedQ.xml"/>
+ </topicref>
+ <topicref navtitle="Recursive locks">
+ <topicref
href="../../reference/lib/common-dylan/threads/Lrecursive_lockG.xml"/>
+ </topicref>
+ <topicref navtitle="Simple locks">
+ <topicref
href="../../reference/lib/common-dylan/threads/Lsimple_lockG.xml"/>
+ </topicref>
+ <topicref navtitle="Multiple reader / single writer locks">
+ <topicref
href="../../reference/lib/common-dylan/threads/Lread_write_lockG.xml"/>
+ </topicref>
+ <topicref navtitle="Notifications">
+ <topicref
href="../../reference/lib/common-dylan/threads/LnotificationG.xml"/>
+ <topicref
href="../../reference/lib/common-dylan/threads/associated_lock.xml"/>
+ <topicref
href="../../reference/lib/common-dylan/threads/release_all.xml"/>
+ </topicref>
+ </topicref>
+ <topicref navtitle="Timers">
+ <topicref href="../../reference/lib/common-dylan/threads/sleep.xml"/>
+ </topicref>
+ <topicref navtitle="Thread variables">
+ </topicref>
+ <topicref navtitle="Dynamic binding">
+ <topicref
href="../../reference/lib/common-dylan/threads/dynamic_bind.xml"/>
+ </topicref>
+ <topicref navtitle="Locked variables">
+ </topicref>
+ <topicref navtitle="Conditional update">
+ </topicref>
</map>
Modified: trunk/documentation/topic/reference/lib/common-dylan/threads.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/threads.xml
(original)
+++ trunk/documentation/topic/reference/lib/common-dylan/threads.xml Wed Jun
7 06:47:21 2006
@@ -14,7 +14,12 @@
<dylanModuleDetail>
<apiDesc>
- <p></p>
+ <p>The <apipackage>threads</apipackage> module of the
+ <apipackage>common-dylan</apipackage> library provides a
+ portable threads interface for Dylan. The
+ <apipackage>threads</apipackage> module is designed to map
+ easily and efficiently onto the threads facilities provided by
+ all common operating systems. </p>
</apiDesc>
</dylanModuleDetail>
Modified:
trunk/documentation/topic/reference/lib/common-dylan/threads/LnotificationG.xml
==============================================================================
---
trunk/documentation/topic/reference/lib/common-dylan/threads/LnotificationG.xml
(original)
+++
trunk/documentation/topic/reference/lib/common-dylan/threads/LnotificationG.xml
Wed Jun 7 06:47:21 2006
@@ -43,9 +43,9 @@
<p>Threads wait for the change of state to be notified by
calling <apioperation
- href="wait_for.xml">wait-for</apioperation> . Threads notify
- other threads of the change of state by calling
- <apioperation xref="release.xml">release</apioperation> .</p>
+ href="wait_for.xml">wait-for</apioperation>. Threads notify
+ other threads of the change of state by calling <apioperation
+ href="release.xml">release</apioperation> .</p>
</apiDesc>
<example>
Modified:
trunk/documentation/topic/reference/lib/common-dylan/threads/LthreadG.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/threads/LthreadG.xml
(original)
+++ trunk/documentation/topic/reference/lib/common-dylan/threads/LthreadG.xml
Wed Jun 7 06:47:21 2006
@@ -65,7 +65,7 @@
</ul>
<p>The <parmname>name</parmname> keyword is a string that is
- used as the thread’s name for convenience purposes, such for
+ used as the thread’s name for convenience purposes, such as for
display in the debugger.</p>
</apiDesc>
</dylanClassDetail>
Added:
trunk/documentation/topic/reference/lib/common-dylan/threads/threads-class-hierarchy.svg
==============================================================================
Binary file. No diff available.
Added:
trunk/documentation/topic/reference/lib/common-dylan/threads/threads-class-hierarchy.xml
==============================================================================
--- (empty file)
+++
trunk/documentation/topic/reference/lib/common-dylan/threads/threads-class-hierarchy.xml
Wed Jun 7 06:47:21 2006
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd" []>
+<reference id="reference-threads-class-hierarchy">
+ <title>Threads Class Hierarchy</title>
+
+ <refbody>
+ <section><image href="threads-class-hierarchy.svg"/></section>
+ </refbody>
+</reference>
--
Gd-chatter mailing list
Gd-chatter@xxxxxxxxxxxxxxxx
https://www.gwydiondylan.org/mailman/listinfo/gd-chatter
|
