
|
[haiku-doc]
||
[Date Prev]
[05-2007 Date Index]
[Date Next]
||
[Thread Prev]
[05-2007 Thread Index]
[Thread Next]
[haiku-doc] First diff for List.dox
- From: David Weizades <ddewbofh@xxxxxxxxxxx>
- To: <haiku-doc@xxxxxxxxxxxxx>
- Date: Tue, 22 May 2007 12:20:42 +0200
Hi all,
Attached is the first diff for the file List.dox in /haiku/docs/user/support It
applies fine here and all lines are proper 80 chars. Only done the first
paragraph so far, still getting my bearings. The next set of changes should
come sooner as I pick up momentum. :)
Enjoy
Dave
_________________________________________________________________
Prova Live.com - din snabba, personliga hemsida med allt du kan önska dig på
ett enda ställe.
http://www.live.com/getstarted Index: List.dox
===================================================================
--- List.dox (revision 21193)
+++ List.dox (arbetskopia)
@@ -2,8 +2,12 @@
* Copyright 2007, Haiku, Inc. All Rights Reserved.
* Distributed under the terms of the MIT License.
*
- * Documentation by:
- * Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
+ * Authors:
+ * Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
+ *
+ * Proofreading:
+ * David Weizades <ddewbofh@xxxxxxxxxxx>
+ *
* Corresponds to:
* /trunk/headers/os/support/List.h rev 19972
* /trunk/src/kits/support/List.cpp rev 18649
@@ -22,27 +26,27 @@
objects.
This class is designed to be used for a variety of tasks. Unlike similar
- implementations in other libraries, this class is not based on templates,
- and as such is inherently not typed. So it will be the job of the coder to
- make sure proper data will be entered, since the compiler cannot check this.
+ implementations in other libraries, this class is not based on templates
+ and as such is inherently not typed. So it will be the job of the programmer
+ to make sure proper data is entered since the compiler cannot check this
+ itself.
- BList contains a list of items that will grow and shrink depending on
- how much items are in it. So you will not have to do any of the
- memory management. Furthermore, it's ordered. Those properties make it
- useful in a whole range of situations, for example in the interface kit in
- the BListView class.
+ BList contains a list of items that will grow and shrink depending on how
+ many items are in it. So you will not have to do any of the memory management
+ nor any ordering. These properties makes it useful in a whole range of
+ situations such as the interface kit within the BListView class.
- A note on ownership of the objects might come in handy. BList at no time
- assumes ownership of the objects, so removing items from the list will
- only remove those items from the list, it will not delete the item. In the
- same spirit you should also make sure that before you might delete an
- object that's in a list, you will remove it from the list first.
+ A note on the ownership of the objects might come in handy. BList never
+ assumes ownership of the objects, removing items from the list will
+ only remove the entries from the list not delete the items themselves. In the
+ same way you should also make sure that before you might delete an object
+ that's in a list, you will have to remove it from the list first.
\warning This class is not thread-safe.
- The class implements methods to add and remove items, reorder items,
- retrieve items, querying for items and some advanced methods which let
- you perform a certain tasks to all the items of the list.
+ The class implements methods to add, remove, reorder, retrieve, query
+ items as well as some advanced methods which let you perform a task on all
the
+ items in the list.
*/
/*!
@@ -51,8 +55,9 @@
The memory management of this class allocates new memory per block. The
\c count parameter can be tweaked to determine the size of those blocks.
- In general, if you know your list is only going to contain a fixed maximum
- number of items, pass that value. If you expect your list to have very few
+ In general, if you know your list is only going to contain a maximum number
of
+ items, you can pass that value. If you expect your list to have very
+few
items, it's probably safe to choose a low number. This is as to prevent the
list from taking up unneccesary memory. If you expect the list to contain a
large number of items, choose a higher value, since every time the memory is
|

|