class: LinkedList
authorClaus Gittinger <cg@exept.de>
Wed, 26 Nov 2014 09:47:42 +0100
changeset 17123 784f5f9ce77f
parent 17122 bf8149233069
child 17124 9c3c21def1fe
class: LinkedList comment/format in: #documentation
LinkedList.st
--- a/LinkedList.st	Wed Nov 26 09:45:13 2014 +0100
+++ b/LinkedList.st	Wed Nov 26 09:47:42 2014 +0100
@@ -43,17 +43,16 @@
 
     LinkedList does not care for storage; all it does is handling
     chained link elements, which must respond to #nextLink/#nextLink:.
-    (i.e. any object which can do this, can be used as elements of a linked
-     list).
+    (i.e. any object which can do this, can be used as elements of a linked list).
     An abstract superclass for linkElements is Link; a concrete class is
     ValueLink, which holds a reference to some object.
 
     [warning:]
         Be careful when subclassing Link, since there is a big drawback,
         which may be overlooked by beginners:
-            a Link element can only be in one LinkedList
+            a Link element can ONLY be in one LinkedList at a time
             - adding the same element to another LinkedList
-            will remove it from the first as a side effect.
+              will remove it from the first as a side effect.
         Therefore, NEVER simply add something to a linkedList (except for
         valueLinks) unless you know what you do.
         The ST-80 implementors probably wanted this behavior, to move
@@ -73,7 +72,7 @@
     For the above reasons, the system does not make heavily use of LinkedLists;
     the only good application is where elements must be repeatedly be removed
     at the front and added at the end.
-    (the schedulers process handling code does this to manage process lists.)
+    (the scheduler's process handling code does this to manage process lists.)
 
     [memory requirements:]
         (OBJ-HEADER + (3 * ptr-size)) * size
@@ -436,10 +435,10 @@
 !LinkedList class methodsFor:'documentation'!
 
 version
-    ^ '$Header: /cvs/stx/stx/libbasic/LinkedList.st,v 1.42 2013-06-25 11:23:45 cg Exp $'
+    ^ '$Header: /cvs/stx/stx/libbasic/LinkedList.st,v 1.43 2014-11-26 08:47:42 cg Exp $'
 !
 
 version_CVS
-    ^ '$Header: /cvs/stx/stx/libbasic/LinkedList.st,v 1.42 2013-06-25 11:23:45 cg Exp $'
+    ^ '$Header: /cvs/stx/stx/libbasic/LinkedList.st,v 1.43 2014-11-26 08:47:42 cg Exp $'
 ! !