[haiku-commits] haiku: hrev47422 - docs/user/support headers/os/support src/kits/support

  • From: jscipione@xxxxxxxxx
  • To: haiku-commits@xxxxxxxxxxxxx
  • Date: Wed, 25 Jun 2014 01:31:32 +0200 (CEST)

hrev47422 adds 2 changesets to branch 'master'
old head: 2661ce4605a59cb594f0c6afbcde427369dceedc
new head: c4b9309a9964a8bf18a834cf41aa97f1172bab0d
overview: http://cgit.haiku-os.org/haiku/log/?qt=range&q=c4b9309+%5E2661ce4

----------------------------------------------------------------------------

29e8fa5: Style fixes to Support Kit files

c4b9309: Update Support Kit docs, add \since
  
  Also add preliminary documentation for BObjectList.

                                     [ John Scipione <jscipione@xxxxxxxxx> ]

----------------------------------------------------------------------------

54 files changed, 2924 insertions(+), 1289 deletions(-)
docs/user/support/Architecture.dox     |   51 +-
docs/user/support/Archivable.dox       |  281 ++++--
docs/user/support/Autolock.dox         |   83 +-
docs/user/support/Beep.dox             |   16 +-
docs/user/support/BlockCache.dox       |   36 +-
docs/user/support/BufferIO.dox         |  109 ++-
docs/user/support/DataIO.dox           |  214 ++--
docs/user/support/Flattenable.dox      |  110 ++-
docs/user/support/List.dox             |  351 +++++--
docs/user/support/Locker.dox           |  134 ++-
docs/user/support/ObjectList.dox       |  509 ++++++++++
docs/user/support/StopWatch.dox        |   22 +-
docs/user/support/String.dox           | 1446 ++++++++++++++++++----------
docs/user/support/SupportDefs.dox      |  124 ++-
docs/user/support/TLS.dox              |   41 +-
docs/user/support/TypeConstants.dox    |   69 +-
docs/user/support/parsedate.dox        |  101 +-
headers/os/support/Architecture.h      |   16 +-
headers/os/support/Archivable.h        |    2 +-
headers/os/support/Autolock.h          |    7 +-
headers/os/support/Beep.h              |    4 +-
headers/os/support/BlockCache.h        |    1 +
headers/os/support/BufferIO.h          |    2 +-
headers/os/support/BufferedDataIO.h    |    2 +-
headers/os/support/ByteOrder.h         |   12 +-
headers/os/support/ClassInfo.h         |    4 +-
headers/os/support/DataIO.h            |    2 +-
headers/os/support/DateTime.h          |   11 +-
headers/os/support/Debug.h             |    2 +-
headers/os/support/Errors.h            |    2 +-
headers/os/support/Flattenable.h       |    2 +-
headers/os/support/List.h              |   11 +-
headers/os/support/Locker.h            |    2 +-
headers/os/support/ObjectList.h        |   29 +-
headers/os/support/String.h            |   49 +-
headers/os/support/StringList.h        |    8 +-
headers/os/support/SupportDefs.h       |    2 +-
headers/os/support/TLS.h               |   12 +-
headers/os/support/TypeConstants.h     |   48 +-
headers/os/support/UTF8.h              |   40 +-
headers/os/support/parsedate.h         |    6 +-
src/kits/support/Archivable.cpp        |   39 +-
src/kits/support/ArchivingManagers.cpp |    5 +-
src/kits/support/ArchivingManagers.h   |    5 +-
src/kits/support/Base64.cpp            |   21 +-
src/kits/support/Beep.cpp              |    1 -
src/kits/support/BufferIO.cpp          |    6 +-
src/kits/support/DataIO.cpp            |   30 +-
src/kits/support/DateTime.cpp          |   10 +-
src/kits/support/List.cpp              |   84 +-
src/kits/support/Locker.cpp            |    4 +-
src/kits/support/String.cpp            |   24 +-
src/kits/support/Url.cpp               |    4 +-
src/kits/support/Uuid.cpp              |    7 +-

############################################################################

Commit:      29e8fa5922c9f9a5eb09a2fcc92e7fb321d4cc59
URL:         http://cgit.haiku-os.org/haiku/commit/?id=29e8fa5
Author:      John Scipione <jscipione@xxxxxxxxx>
Date:        Tue Jun 24 23:25:27 2014 UTC

Style fixes to Support Kit files

----------------------------------------------------------------------------

diff --git a/headers/os/support/Architecture.h 
b/headers/os/support/Architecture.h
index 5ed8bc7..a14d437 100644
--- a/headers/os/support/Architecture.h
+++ b/headers/os/support/Architecture.h
@@ -1,9 +1,9 @@
 /*
- * Copyright 2013, Haiku, Inc. All Rights Reserved.
+ * Copyright 2013-2014 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
-#ifndef _SUPPORT_ARCHITECTURE_H
-#define _SUPPORT_ARCHITECTURE_H
+#ifndef _ARCHITECTURE_H
+#define _ARCHITECTURE_H
 
 
 #include <sys/cdefs.h>
@@ -13,7 +13,6 @@
 
 __BEGIN_DECLS
 
-
 const char*    get_architecture();
 const char*    get_primary_architecture();
 size_t         get_secondary_architectures(const char** architectures,
@@ -21,22 +20,17 @@ size_t              get_secondary_architectures(const 
char** architectures,
 size_t         get_architectures(const char** architectures, size_t count);
 const char*    guess_architecture_for_path(const char* path);
 
-
 __END_DECLS
 
 
 /* C++ API */
 #ifdef __cplusplus
 
-
 #include <StringList.h>
 
-
 status_t       get_secondary_architectures(BStringList& _architectures);
 status_t       get_architectures(BStringList& _architectures);
 
+#endif /* __cplusplus */
 
-#endif
-
-
-#endif /* _SUPPORT_ARCHITECTURE_H */
+#endif /* _ARCHITECTURE_H */
diff --git a/headers/os/support/Archivable.h b/headers/os/support/Archivable.h
index 88fe3b8..3f022c3 100644
--- a/headers/os/support/Archivable.h
+++ b/headers/os/support/Archivable.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2001-2010, Haiku, Inc. All Rights Reserved.
+ * Copyright 2001-2010 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _ARCHIVABLE_H
diff --git a/headers/os/support/Autolock.h b/headers/os/support/Autolock.h
index fb7db6b..fbe793b 100644
--- a/headers/os/support/Autolock.h
+++ b/headers/os/support/Autolock.h
@@ -2,8 +2,8 @@
  * Copyright 2001-2009, Haiku, Inc. All Rights Reserved.
  * Distributed under the terms of the MIT License.
  */
-#ifndef        _SUPPORT_AUTOLOCK_H
-#define        _SUPPORT_AUTOLOCK_H
+#ifndef        _AUTOLOCK_H
+#define        _AUTOLOCK_H
 
 
 #include <Locker.h>
@@ -101,4 +101,5 @@ BAutolock::Unlock()
                fLocker->Unlock();
 }
 
-#endif // _SUPPORT_AUTOLOCK_H
+
+#endif // _AUTOLOCK_H
diff --git a/headers/os/support/Beep.h b/headers/os/support/Beep.h
index 0c49e54..b8adb71 100644
--- a/headers/os/support/Beep.h
+++ b/headers/os/support/Beep.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2007, Haiku, Inc. All Rights Reserved.
+ * Copyright 2007-2014 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _BEEP_H
@@ -17,6 +17,6 @@ status_t beep();
 status_t system_beep(const char* eventName);
 status_t add_system_beep_event(const char* eventName, uint32 flags = 0);
 
-#endif
+#endif // __cplusplus
 
 #endif // _BEEP_H
diff --git a/headers/os/support/BlockCache.h b/headers/os/support/BlockCache.h
index 873c8d7..c9c6a79 100644
--- a/headers/os/support/BlockCache.h
+++ b/headers/os/support/BlockCache.h
@@ -61,4 +61,5 @@ class BBlockCache {
                uint32          _reserved[2];
 };
 
+
 #endif // _BLOCK_CACHE_H
diff --git a/headers/os/support/BufferIO.h b/headers/os/support/BufferIO.h
index 00ace8e..f5eccc8 100644
--- a/headers/os/support/BufferIO.h
+++ b/headers/os/support/BufferIO.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2007-2010, Haiku, Inc. All Rights Reserved.
+ * Copyright 2007-2010 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _BUFFER_IO_H
diff --git a/headers/os/support/BufferedDataIO.h 
b/headers/os/support/BufferedDataIO.h
index 4e24790..0d100d1 100644
--- a/headers/os/support/BufferedDataIO.h
+++ b/headers/os/support/BufferedDataIO.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2011, Haiku, Inc. All Rights Reserved.
+ * Copyright 2011 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _BUFFERED_DATA_IO_H
diff --git a/headers/os/support/ByteOrder.h b/headers/os/support/ByteOrder.h
index de6e959..39819d4 100644
--- a/headers/os/support/ByteOrder.h
+++ b/headers/os/support/ByteOrder.h
@@ -1,9 +1,9 @@
 /*
- * Copyright 2007, Haiku, Inc. All Rights Reserved.
+ * Copyright 2007 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
-#ifndef _BYTEORDER_H
-#define _BYTEORDER_H
+#ifndef _BYTE_ORDER_H
+#define _BYTE_ORDER_H
 
 
 #include <BeBuild.h>
@@ -111,7 +111,7 @@ typedef enum {
 
 #ifdef __cplusplus
 extern "C" {
-#endif
+#endif /* __cplusplus */
 
 extern status_t swap_data(type_code type, void *data, size_t length,
        swap_action action);
@@ -132,6 +132,6 @@ extern uint16 __swap_int16(uint16 arg);
 
 #ifdef __cplusplus
 }
-#endif
+#endif /*  __cplusplus */
 
-#endif /* _BYTEORDER_H */
+#endif /* _BYTE_ORDER_H */
diff --git a/headers/os/support/ClassInfo.h b/headers/os/support/ClassInfo.h
index 0df2c19..d689c41 100644
--- a/headers/os/support/ClassInfo.h
+++ b/headers/os/support/ClassInfo.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2007, Haiku, Inc. All Rights Reserved.
+ * Copyright 2007 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _CLASS_INFO_H
@@ -20,5 +20,5 @@
        (dynamic_cast<class*>(object) != NULL)
 #define is_instance_of(object, class) \
        (typeid(*(object)) == typeid(class))
-       
+
 #endif // _CLASS_INFO_H
diff --git a/headers/os/support/DataIO.h b/headers/os/support/DataIO.h
index 1e5dc6a..e39bdcf 100644
--- a/headers/os/support/DataIO.h
+++ b/headers/os/support/DataIO.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2005-2014, Haiku, Inc. All rights reserved.
+ * Copyright 2005-2014 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _DATA_IO_H
diff --git a/headers/os/support/DateTime.h b/headers/os/support/DateTime.h
index 17e1c65..3d06bb4 100644
--- a/headers/os/support/DateTime.h
+++ b/headers/os/support/DateTime.h
@@ -1,9 +1,9 @@
 /*
- * Copyright 2007-2010, Haiku, Inc. All Rights Reserved.
+ * Copyright 2007-2010 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
-#ifndef _DATE_TIME_H_
-#define _DATE_TIME_H_
+#ifndef _DATE_TIME_H
+#define _DATE_TIME_H
 
 
 #include <String.h>
@@ -14,7 +14,6 @@ class BMessage;
 
 namespace BPrivate {
 
-
 enum time_type {
        B_GMT_TIME,
        B_LOCAL_TIME
@@ -206,10 +205,8 @@ private:
                        BTime                           fTime;
 };
 
-
 }      // namespace BPrivate
 
-
 using BPrivate::time_type;
 using BPrivate::B_GMT_TIME;
 using BPrivate::B_LOCAL_TIME;
@@ -224,4 +221,4 @@ using BPrivate::BDate;
 using BPrivate::BDateTime;
 
 
-#endif // _DATE_TIME_H_
+#endif // _DATE_TIME_H
diff --git a/headers/os/support/Debug.h b/headers/os/support/Debug.h
index 1f88b27..9cc39fd 100644
--- a/headers/os/support/Debug.h
+++ b/headers/os/support/Debug.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2007, Haiku, Inc. All Rights Reserved.
+ * Copyright 2007 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _DEBUG_H
diff --git a/headers/os/support/Errors.h b/headers/os/support/Errors.h
index 62343b4..285b56d 100644
--- a/headers/os/support/Errors.h
+++ b/headers/os/support/Errors.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2007-2014, Haiku, Inc. All Rights Reserved.
+ * Copyright 2007-2014 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _ERRORS_H
diff --git a/headers/os/support/Flattenable.h b/headers/os/support/Flattenable.h
index 40a4deb..1eee881 100644
--- a/headers/os/support/Flattenable.h
+++ b/headers/os/support/Flattenable.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2007-2010, Haiku, Inc. All Rights Reserved.
+ * Copyright 2007-2010 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef        _FLATTENABLE_H
diff --git a/headers/os/support/List.h b/headers/os/support/List.h
index 6aa67d0..dd38992 100644
--- a/headers/os/support/List.h
+++ b/headers/os/support/List.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2001-2009, Haiku, Inc. All Rights Reserved.
+ * Copyright 2001-2009 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _BE_LIST_H
@@ -12,14 +12,14 @@
 class BList {
 public:
                                                                BList(int32 
count = 20);
-                                                               BList(const 
BList& anotherList);
+                                                               BList(const 
BList& other);
        virtual                                         ~BList();
 
                        BList&                          operator=(const BList& 
other);
                        bool                            operator==(const BList& 
other) const;
                        bool                            operator!=(const BList& 
other) const;
 
-       // Adding and removing items.
+       // Adding and removing items
                        bool                            AddItem(void* item, 
int32 index);
                        bool                            AddItem(void* item);
                        bool                            AddList(const BList* 
list, int32 index);
@@ -28,7 +28,7 @@ public:
                        bool                            RemoveItem(void* item);
                        void*                           RemoveItem(int32 index);
                        bool                            RemoveItems(int32 
index, int32 count);
-                       bool                            ReplaceItem(int32 
index, void* newItem);
+                       bool                            ReplaceItem(int32 
index, void* item);
 
                        void                            MakeEmpty();
 
@@ -36,7 +36,7 @@ public:
                        void                            SortItems(int 
(*compareFunc)(const void*,
                                                                        const 
void*));
                        bool                            SwapItems(int32 indexA, 
int32 indexB);
-                       bool                            MoveItem(int32 
fromIndex, int32 toIndex);
+                       bool                            MoveItem(int32 from, 
int32 to);
 
        // Retrieve items
                        void*                           ItemAt(int32 index) 
const;
@@ -76,4 +76,5 @@ private:
                        uint32                          _reserved[1];
 };
 
+
 #endif // _BE_LIST_H
diff --git a/headers/os/support/Locker.h b/headers/os/support/Locker.h
index 5816bae..7c115bd 100644
--- a/headers/os/support/Locker.h
+++ b/headers/os/support/Locker.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2001-2010, Haiku, Inc. All Rights Reserved.
+ * Copyright 2001-2010 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef        _LOCKER_H
diff --git a/headers/os/support/ObjectList.h b/headers/os/support/ObjectList.h
index f0e1927..af30f89 100644
--- a/headers/os/support/ObjectList.h
+++ b/headers/os/support/ObjectList.h
@@ -51,11 +51,12 @@ template<class T> class BObjectList;
 
 template<class T>
 struct UnaryPredicate {
-
        virtual int operator()(const T *) const
                // virtual could be avoided here if FindBinaryInsertionIndex,
                // etc. were member template functions
-               { return 0; }
+       {
+               return 0;
+       }
 
 private:
        static int _unary_predicate_glue(const void *item, void *context);
@@ -112,7 +113,6 @@ protected:
 template<class T>
 class BObjectList : private _PointerList_ {
 public:
-
        // iteration and sorting
        typedef T*                                      (*EachFunction)(T*, 
void*);
        typedef const T*                        (*ConstEachFunction)(const T*, 
void*);
@@ -424,7 +424,7 @@ BObjectList<T>::BObjectList(int32 itemsPerBlock, bool 
owning)
 
 
 template<class T>
-BObjectList<T>::BObjectList(const BObjectList<T> &list)
+BObjectList<T>::BObjectList(const BObjectList<T>& list)
        :
        _PointerList_(list)
 {
@@ -483,25 +483,25 @@ BObjectList<T>::AddItem(T* item)
 
 template<class T>
 bool
-BObjectList<T>::AddItem(T* item, int32 atIndex)
+BObjectList<T>::AddItem(T* item, int32 index)
 {
-       return _PointerList_::AddItem((void*)item, atIndex);
+       return _PointerList_::AddItem((void*)item, index);
 }
 
 
 template<class T>
 bool
-BObjectList<T>::AddList(BObjectList<T>* newItems)
+BObjectList<T>::AddList(BObjectList<T>* list)
 {
-       return _PointerList_::AddList(newItems);
+       return _PointerList_::AddList(list);
 }
 
 
 template<class T>
 bool
-BObjectList<T>::AddList(BObjectList<T>* newItems, int32 atIndex)
+BObjectList<T>::AddList(BObjectList<T>* list, int32 index)
 {
-       return _PointerList_::AddList(newItems, atIndex);
+       return _PointerList_::AddList(list, index);
 }
 
 
@@ -540,16 +540,18 @@ BObjectList<T>::ReplaceItem(int32 index, T* item)
 {
        if (owning)
                delete ItemAt(index);
+
        return _PointerList_::ReplaceItem(index, (void*)item);
 }
 
 
 template<class T>
 T*
-BObjectList<T>::SwapWithItem(int32 index, T* newItem)
+BObjectList<T>::SwapWithItem(int32 index, T* item)
 {
        T* result = ItemAt(index);
-       _PointerList_::ReplaceItem(index, (void*)newItem);
+       _PointerList_::ReplaceItem(index, (void*)item);
+
        return result;
 }
 
@@ -712,6 +714,7 @@ BObjectList<T>::BinarySearch(const T& key, CompareFunction 
func) const
        return (T*)_PointerList_::BinarySearch(&key, 
(GenericCompareFunction)func);
 }
 
+
 template<class T>
 T*
 BObjectList<T>::BinarySearch(const T& key, CompareFunctionWithState func,
@@ -942,4 +945,4 @@ BObjectList<T>::BinaryInsertUnique(T* item, const 
UnaryPredicate<T>& pred)
 }
 
 
-#endif /* _OBJECT_LIST_H */
+#endif // _OBJECT_LIST_H
diff --git a/headers/os/support/String.h b/headers/os/support/String.h
index 7ca3b64..9dcc88c 100644
--- a/headers/os/support/String.h
+++ b/headers/os/support/String.h
@@ -1,9 +1,9 @@
 /*
- * Copyright 2001-2010, Haiku Inc. All Rights Reserved.
+ * Copyright 2001-2010 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
-#ifndef __BSTRING__
-#define __BSTRING__
+#ifndef _B_STRING_H
+#define _B_STRING_H
 
 
 #include <stdarg.h>
@@ -383,7 +383,7 @@ private:
 
                        // Escape
                        BString&                _DoCharacterEscape(const char* 
string,
-                                                               const char 
*setOfCharsToEscape, char escapeChar);
+                                                               const char* 
setOfCharsToEscape, char escapeChar);
                        BString&                _DoCharacterDeescape(const 
char* string,
                                                                char 
escapeChar);
 
@@ -426,7 +426,7 @@ BString::Length() const
 {
        // the most significant bit is reserved; accessing
        // it in any way will cause the computer to explode
-       return fPrivateData ? (*(((int32 *)fPrivateData) - 1) & 0x7fffffff) : 0;
+       return fPrivateData ? (*(((int32*)fPrivateData) - 1) & 0x7fffffff) : 0;
 }
 
 
@@ -453,7 +453,7 @@ BString::HashValue() const
 }
 
 
-inline BString &
+inline BString&
 BString::SetTo(const char* string)
 {
        return operator=(string);
@@ -476,23 +476,23 @@ BString::ByteAt(int32 index) const
 }
 
 
-inline BString &
-BString::operator+=(const BString &string)
+inline BString&
+BString::operator+=(const BString& string)
 {
        _DoAppend(string.String(), string.Length());
        return *this;
 }
 
 
-inline BString &
-BString::Append(const BString &string)
+inline BString&
+BString::Append(const BString& string)
 {
        _DoAppend(string.String(), string.Length());
        return *this;
 }
 
 
-inline BString &
+inline BString&
 BString::Append(const char* string)
 {
        return operator+=(string);
@@ -500,42 +500,42 @@ BString::Append(const char* string)
 
 
 inline bool
-BString::operator==(const BString &string) const
+BString::operator==(const BString& string) const
 {
        return strcmp(String(), string.String()) == 0;
 }
 
 
 inline bool
-BString::operator<(const BString &string) const
+BString::operator<(const BString& string) const
 {
        return strcmp(String(), string.String()) < 0;
 }
 
 
 inline bool
-BString::operator<=(const BString &string) const
+BString::operator<=(const BString& string) const
 {
        return strcmp(String(), string.String()) <= 0;
 }
 
 
 inline bool
-BString::operator>=(const BString &string) const
+BString::operator>=(const BString& string) const
 {
        return strcmp(String(), string.String()) >= 0;
 }
 
 
 inline bool
-BString::operator>(const BString &string) const
+BString::operator>(const BString& string) const
 {
        return strcmp(String(), string.String()) > 0;
 }
 
 
 inline bool
-BString::operator!=(const BString &string) const
+BString::operator!=(const BString& string) const
 {
        return strcmp(String(), string.String()) != 0;
 }
@@ -556,42 +556,42 @@ BString::operator const char*() const
 
 
 inline bool
-operator<(const char *str, const BString &string)
+operator<(const char* str, const BString& string)
 {
        return string > str;
 }
 
 
 inline bool
-operator<=(const char *str, const BString &string)
+operator<=(const char* str, const BString& string)
 {
        return string >= str;
 }
 
 
 inline bool
-operator==(const char *str, const BString &string)
+operator==(const char* str, const BString& string)
 {
        return string == str;
 }
 
 
 inline bool
-operator>(const char *str, const BString &string)
+operator>(const char* str, const BString& string)
 {
        return string < str;
 }
 
 
 inline bool
-operator>=(const char *str, const BString &string)
+operator>=(const char* str, const BString& string)
 {
        return string <= str;
 }
 
 
 inline bool
-operator!=(const char *str, const BString &string)
+operator!=(const char* str, const BString& string)
 {
        return string != str;
 }
@@ -618,4 +618,5 @@ private:
        int32           fPosition;
 };
 
-#endif // __BSTRING__
+
+#endif // _B_STRING_H
diff --git a/headers/os/support/StringList.h b/headers/os/support/StringList.h
index c193812..559e8d6 100644
--- a/headers/os/support/StringList.h
+++ b/headers/os/support/StringList.h
@@ -1,9 +1,9 @@
 /*
- * Copyright 2011, Haiku, Inc. All Rights Reserved.
+ * Copyright 2011 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
-#ifndef _SUPPORT_BSTRING_LIST_H_
-#define _SUPPORT_BSTRING_LIST_H_
+#ifndef _STRING_LIST_H
+#define _STRING_LIST_H
 
 
 #include <BeBuild.h>
@@ -100,4 +100,4 @@ BStringList::operator!=(const BStringList& other) const
 }
 
 
-#endif // _SUPPORT_BSTRING_LIST_H_
+#endif // _STRING_LIST_H
diff --git a/headers/os/support/SupportDefs.h b/headers/os/support/SupportDefs.h
index aae8002..1f413d3 100644
--- a/headers/os/support/SupportDefs.h
+++ b/headers/os/support/SupportDefs.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2004-2010, Haiku, Inc. All Rights Reserved.
+ * Copyright 2004-2010 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  *
  * Author:
diff --git a/headers/os/support/TLS.h b/headers/os/support/TLS.h
index 9f2d494..344e58d 100644
--- a/headers/os/support/TLS.h
+++ b/headers/os/support/TLS.h
@@ -1,9 +1,9 @@
 /*
- * Copyright 2003-2007, Haiku, Inc. All Rights Reserved.
+ * Copyright 2003-2007 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _TLS_H
-#define        _TLS_H
+#define _TLS_H
 
 
 #include <BeBuild.h>
@@ -19,7 +19,7 @@
 
 #ifdef __cplusplus
 extern "C" {
-#endif
+#endif /* __cplusplus */
 
 extern int32 tls_allocate(void);
 
@@ -54,16 +54,16 @@ tls_set(int32 index, void *value)
                : : "r" (index), "r" (value));
 }
 
-#else
+#else  /* !_NO_INLINE_ASM && __INTEL__ && __GNUC__ */
 
 extern void *tls_get(int32 index);
 extern void **tls_address(int32 index);
 extern void tls_set(int32 index, void *value);
 
-#endif
+#endif /* !_NO_INLINE_ASM && __INTEL__ && __GNUC__ */
 
 #ifdef __cplusplus
 }
-#endif
+#endif /* __cplusplus */
 
 #endif /* _TLS_H */
diff --git a/headers/os/support/TypeConstants.h 
b/headers/os/support/TypeConstants.h
index 9272b04..33f8d20 100644
--- a/headers/os/support/TypeConstants.h
+++ b/headers/os/support/TypeConstants.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2005-2010, Haiku, Inc. All Rights Reserved.
+ * Copyright 2005-2010 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  *
  * Author:
@@ -63,23 +63,37 @@ enum {
        B_NETWORK_ADDRESS_TYPE                  = 'NWAD',
        B_MIME_STRING_TYPE                              = 'MIMS',
 
-       // deprecated, do not use
-       B_ASCII_TYPE                                    = 'TEXT'        // use 
B_STRING_TYPE instead
+       /* deprecated, do not use */
+       B_ASCII_TYPE                                    = 'TEXT'
+               /* use B_STRING_TYPE instead */
 };
 
-// System-wide MIME types for handling URL's
+/* System-wide MIME types for handling URL's */
 
-extern const char *B_URL_HTTP;                 // application/x-vnd.Be.URL.http
-extern const char *B_URL_HTTPS;        // application/x-vnd.Be.URL.https
-extern const char *B_URL_FTP;          // application/x-vnd.Be.URL.ftp
-extern const char *B_URL_GOPHER;       // application/x-vnd.Be.URL.gopher
-extern const char *B_URL_MAILTO;       // application/x-vnd.Be.URL.mailto
-extern const char *B_URL_NEWS;         // application/x-vnd.Be.URL.news
-extern const char *B_URL_NNTP;         // application/x-vnd.Be.URL.nntp
-extern const char *B_URL_TELNET;       // application/x-vnd.Be.URL.telnet
-extern const char *B_URL_RLOGIN;       // application/x-vnd.Be.URL.rlogin
-extern const char *B_URL_TN3270;       // application/x-vnd.Be.URL.tn3270
-extern const char *B_URL_WAIS;         // application/x-vnd.Be.URL.wais
-extern const char *B_URL_FILE;         // application/x-vnd.Be.URL.file
+extern const char* B_URL_HTTP;
+       /* application/x-vnd.Be.URL.http */
+extern const char* B_URL_HTTPS;
+       /* application/x-vnd.Be.URL.https */
+extern const char* B_URL_FTP;
+       /*  application/x-vnd.Be.URL.ftp */
+extern const char* B_URL_GOPHER;
+       /*  application/x-vnd.Be.URL.gopher */
+extern const char* B_URL_MAILTO;
+       /*  application/x-vnd.Be.URL.mailto */
+extern const char* B_URL_NEWS;
+       /*  application/x-vnd.Be.URL.news */
+extern const char* B_URL_NNTP;
+       /*  application/x-vnd.Be.URL.nntp */
+extern const char* B_URL_TELNET;
+       /*  application/x-vnd.Be.URL.telnet */
+extern const char* B_URL_RLOGIN;
+       /*  application/x-vnd.Be.URL.rlogin */
+extern const char* B_URL_TN3270;
+       /*  application/x-vnd.Be.URL.tn3270 */
+extern const char* B_URL_WAIS;
+       /*  application/x-vnd.Be.URL.wais */
+extern const char* B_URL_FILE;
+       /*  application/x-vnd.Be.URL.file */
 
-#endif // _TYPE_CONSTANTS_H
+
+#endif /* _TYPE_CONSTANTS_H */
diff --git a/headers/os/support/UTF8.h b/headers/os/support/UTF8.h
index ab5416a..e7e10a5 100644
--- a/headers/os/support/UTF8.h
+++ b/headers/os/support/UTF8.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2007, Haiku, Inc. All Rights Reserved.
+ * Copyright 2007 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _UTF8_H
@@ -11,9 +11,9 @@
 #include <SupportDefs.h>
 
 
-// Conversion Flavors
+/*  Conversion Flavors */
 enum {
-       B_ISO1_CONVERSION,                              // ISO 8859-x
+       B_ISO1_CONVERSION,                              /*  ISO 8859-x */
        B_ISO2_CONVERSION,
        B_ISO3_CONVERSION,
        B_ISO4_CONVERSION,
@@ -23,28 +23,28 @@ enum {
        B_ISO8_CONVERSION,
        B_ISO9_CONVERSION,
        B_ISO10_CONVERSION,
-       B_MAC_ROMAN_CONVERSION,                 // Macintosh Roman
-       B_SJIS_CONVERSION,                              // Shift-JIS
-       B_EUC_CONVERSION,                               // EUC Packed Japanese
-       B_JIS_CONVERSION,                               // JIS X 0208-1990
-       B_MS_WINDOWS_CONVERSION,                // Windows Latin-1 Codepage 1252
-       B_UNICODE_CONVERSION,                   // Unicode 2.0, UCS-2
-       B_KOI8R_CONVERSION,                             // KOI8-R
-       B_MS_WINDOWS_1251_CONVERSION,   // Windows Cyrillic Codepage 1251
-       B_MS_DOS_866_CONVERSION,                // MS-DOS Codepage 866
-       B_MS_DOS_CONVERSION,                    // MS-DOS Codepage 437
-       B_EUC_KR_CONVERSION,                    // EUC Korean
+       B_MAC_ROMAN_CONVERSION,                 /*  Macintosh Roman */
+       B_SJIS_CONVERSION,                              /*  Shift-JIS */
+       B_EUC_CONVERSION,                               /*  EUC Packed Japanese 
*/
+       B_JIS_CONVERSION,                               /*  JIS X 0208-1990 */
+       B_MS_WINDOWS_CONVERSION,                /*  Windows Latin-1 Codepage 
1252 */
+       B_UNICODE_CONVERSION,                   /*  Unicode 2.0, UCS-2 */
+       B_KOI8R_CONVERSION,                             /*  KOI8-R */
+       B_MS_WINDOWS_1251_CONVERSION,   /*  Windows Cyrillic Codepage 1251 */
+       B_MS_DOS_866_CONVERSION,                /*  MS-DOS Codepage 866 */
+       B_MS_DOS_CONVERSION,                    /*  MS-DOS Codepage 437 */
+       B_EUC_KR_CONVERSION,                    /*  EUC Korean */
        B_ISO13_CONVERSION,
        B_ISO14_CONVERSION,
        B_ISO15_CONVERSION,
-       B_BIG5_CONVERSION,                              // Chinese Big5
-       B_GBK_CONVERSION,                               // Chinese GB18030
-       B_UTF16_CONVERSION,                             // Unicode UTF-16
-       B_MS_WINDOWS_1250_CONVERSION    // Windows Central European Codepage
+       B_BIG5_CONVERSION,                              /*  Chinese Big5 */
+       B_GBK_CONVERSION,                               /*  Chinese GB18030 */
+       B_UTF16_CONVERSION,                             /*  Unicode UTF-16 */
+       B_MS_WINDOWS_1250_CONVERSION    /*  Windows Central European Codepage */
 };
 
 
-// Conversion Functions
+/*  Conversion Functions */
 
 #ifdef __cplusplus
 
@@ -56,6 +56,6 @@ status_t convert_from_utf8(uint32 destEncoding, const char* 
source,
        int32* sourceLength, char* dest, int32* destLength, int32* state,
        char substitute = B_SUBSTITUTE);
 
-#endif
+#endif /* __cplusplus */
 
 #endif /* _UTF8_H */
diff --git a/headers/os/support/parsedate.h b/headers/os/support/parsedate.h
index 6f483a5..5c3e843 100644
--- a/headers/os/support/parsedate.h
+++ b/headers/os/support/parsedate.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2003-2007, Haiku, Inc. All Rights Reserved.
+ * Copyright 2003-2007 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _PARSEDATE_H
@@ -19,7 +19,7 @@
 
 #ifdef __cplusplus
 extern "C" {
-#endif
+#endif /*  __cplusplus */
 
 extern time_t parsedate(const char *dateString, time_t now);
 extern time_t parsedate_etc(const char *dateString, time_t now, int 
*_storedFlags);
@@ -29,6 +29,6 @@ extern const char **get_dateformats(void);
 
 #ifdef __cplusplus
 }
-#endif
+#endif /*  __cplusplus */
 
 #endif /* _PARSEDATE_H */
diff --git a/src/kits/support/Archivable.cpp b/src/kits/support/Archivable.cpp
index 3761040..8c092d9 100644
--- a/src/kits/support/Archivable.cpp
+++ b/src/kits/support/Archivable.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001-2012, Haiku, Inc.
+ * Copyright 2001-2012 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  *
  * Authors:
@@ -237,9 +237,7 @@ check_signature(const char* signature, image_info& info)
 }
 
 
-namespace BPrivate
-{
-
+namespace BPrivate {
 
 instantiation_func
 find_instantiation_func(const char* className, const char* signature,
@@ -294,11 +292,10 @@ find_instantiation_func(const char* className, const 
char* signature,
        return instantiationFunc;
 }
 
+}      // namespace BPrivate
 
-}
 
-
-//     #pragma mark -
+//     #pragma mark - BArchivable
 
 
 BArchivable::BArchivable()
@@ -374,6 +371,7 @@ BArchivable::Perform(perform_code d, void* arg)
                        return B_OK;
                }
        }
+
        return B_NAME_NOT_FOUND;
 }
 
@@ -392,7 +390,7 @@ BArchivable::AllArchived(BMessage* archive) const
 }
 
 
-// #pragma mark -
+// #pragma mark - BArchiver
 
 
 BArchiver::BArchiver(BMessage* archive)
@@ -401,7 +399,7 @@ BArchiver::BArchiver(BMessage* archive)
        fArchive(archive),
        fFinished(false)
 {
-       if (!fManager)
+       if (fManager == NULL)
                fManager = new BArchiveManager(this);
 }
 
@@ -467,7 +465,7 @@ BArchiver::RegisterArchivable(const BArchivable* archivable)
 }
 
 
-// #pragma mark -
+// #pragma mark - BUnarchiver
 
 
 BUnarchiver::BUnarchiver(const BMessage* archive)
@@ -525,6 +523,7 @@ BUnarchiver::IsInstantiated(const char* field, int32 index)
        int32 token;
        if (fArchive->FindInt32(field, index, &token) == B_OK)
                return IsInstantiated(token);
+
        return false;
 }
 
@@ -573,7 +572,7 @@ BUnarchiver::IsArchiveManaged(const BMessage* archive)
        if (BManagerBase::ManagerPointer(archive))
                return true;
 
-       if (!archive)
+       if (archive == NULL)
                return false;
 
        // managed top level archives return here
@@ -588,7 +587,7 @@ BUnarchiver::IsArchiveManaged(const BMessage* archive)
 template<>
 status_t
 BUnarchiver::InstantiateObject<BArchivable>(BMessage* from,
-       BArchivable*& object)
+       BArchivable* &object)
 {
        BUnarchiver unarchiver(BUnarchiver::PrepareArchive(from));
        object = instantiate_object(from);
@@ -597,7 +596,7 @@ BUnarchiver::InstantiateObject<BArchivable>(BMessage* from,
 
 
 BMessage*
-BUnarchiver::PrepareArchive(BMessage*& archive)
+BUnarchiver::PrepareArchive(BMessage* &archive)
 {
        // this check allows PrepareArchive to be
        // called on new or old-style archives
@@ -605,8 +604,10 @@ BUnarchiver::PrepareArchive(BMessage*& archive)
                BUnarchiveManager* manager = 
BManagerBase::UnarchiveManager(archive);
                if (!manager)
                        manager = new BUnarchiveManager(archive);
+
                manager->Acquire();
        }
+
        return archive;
 }
 
@@ -744,6 +745,9 @@ instantiate_object(BMessage* from)
 }
 
 
+//     #pragma mark - support_globals
+
+
 bool
 validate_instantiation(BMessage* from, const char* className)
 {
@@ -807,9 +811,10 @@ find_instantiation_func(BMessage* archive)
 }
 
 
-// BArchivable binary compatibility
-#if __GNUC__ == 2
+//     #pragma mark - BArchivable binary compatibility
+
 
+#if __GNUC__ == 2
 
 extern "C" status_t
 _ReservedArchivable1__11BArchivable(BArchivable* archivable,
@@ -839,7 +844,6 @@ _ReservedArchivable2__11BArchivable(BArchivable* archivable,
 
 #elif __GNUC__ > 2
 
-
 extern "C" status_t
 _ZN11BArchivable20_ReservedArchivable1Ev(BArchivable* archivable,
        const BMessage* archive)
@@ -865,10 +869,7 @@ _ZN11BArchivable20_ReservedArchivable2Ev(BArchivable* 
archivable,
        return performData.return_value;
 }
 
-
 #endif // _GNUC__ > 2
 
 
 void BArchivable::_ReservedArchivable3() {}
-
-
diff --git a/src/kits/support/ArchivingManagers.cpp 
b/src/kits/support/ArchivingManagers.cpp
index 069b339..82838e8 100644
--- a/src/kits/support/ArchivingManagers.cpp
+++ b/src/kits/support/ArchivingManagers.cpp
@@ -1,11 +1,12 @@
 /*
- * Copyright (c) 2010, Haiku, Inc.
+ * Copyright 2010 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  *
  * Authors:
- *             Alex Wilson (yourpalal2@xxxxxxxxx)
+ *             Alex Wilson, yourpalal2@xxxxxxxxx
  */
 
+
 #include "ArchivingManagers.h"
 
 #include <syslog.h>
diff --git a/src/kits/support/ArchivingManagers.h 
b/src/kits/support/ArchivingManagers.h
index 7642352..b4e55f5 100644
--- a/src/kits/support/ArchivingManagers.h
+++ b/src/kits/support/ArchivingManagers.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2010, Haiku, Inc. All Rights Reserved.
+ * Copyright 2010 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _ARCHIVING_MANAGERS_H
@@ -165,4 +165,5 @@ private:
 } // namespace Archiving
 } // namespace BPrivate
 
-#endif
+
+#endif // _ARCHIVING_MANAGERS_H
diff --git a/src/kits/support/Base64.cpp b/src/kits/support/Base64.cpp
index 3f1246c..94ad054 100644
--- a/src/kits/support/Base64.cpp
+++ b/src/kits/support/Base64.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2013, Haiku, Inc. All rights reserved.
+ * Copyright 2011-2013 Haiku, Inc. All rights reserved.
  * Copyright 2001-2003 Dr. Zoidberg Enterprises. All rights reserved.
  */
 
@@ -12,14 +12,14 @@
 
 
 static const char kBase64Alphabet[64] = {
-  'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
-  'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
-  'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
-  'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
-  '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
-  '+',
-  '/'
- };
+       'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 
'O',
+       'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
+       'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 
'o',
+       'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
+       '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
+       '+',
+       '/'
+};
 
 
 ssize_t
@@ -141,5 +141,4 @@ decode_base64(char *out, const char *in, off_t length)
        {
                return decode_base64(out, in, length);
        }
-
-#endif
+#endif //  __GNUC__ <= 2
diff --git a/src/kits/support/Beep.cpp b/src/kits/support/Beep.cpp
index 673d2f4..b4519b7 100644
--- a/src/kits/support/Beep.cpp
+++ b/src/kits/support/Beep.cpp
@@ -57,4 +57,3 @@ add_system_beep_event(const char* name, uint32 flags)
 
        return status;
 }
-
diff --git a/src/kits/support/BufferIO.cpp b/src/kits/support/BufferIO.cpp
index a64d611..744f0e3 100644
--- a/src/kits/support/BufferIO.cpp
+++ b/src/kits/support/BufferIO.cpp
@@ -1,9 +1,9 @@
 /*
- *     Copyright (c) 2001-2008, Haiku
+ *     Copyright 2001-2008 Haiku, Inc. All rights reserved.
  *     Distributed under the terms of the MIT license
  *
  *     Authors:
- *             Stefano Ceccherini (burton666@xxxxxxxxx)
+ *             Stefano Ceccherini, burton666@xxxxxxxxx
  */
 
 
@@ -253,7 +253,7 @@ BBufferIO::PrintToStream() const
 }
 
 
-//     #pragma mark -
+//     #pragma mark - FBC padding
 
 
 // These functions are here to maintain future binary
diff --git a/src/kits/support/DataIO.cpp b/src/kits/support/DataIO.cpp
index 657d195..90c4b8c 100644
--- a/src/kits/support/DataIO.cpp
+++ b/src/kits/support/DataIO.cpp
@@ -1,9 +1,9 @@
 /*
- * Copyright 2005-2014, Haiku, Inc.
+ * Copyright 2005-2014 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  *
  * Authors:
- *             Stefano Ceccherini (burton666@xxxxxxxxx)
+ *             Stefano Ceccherini, burton666@xxxxxxxxx
  */
 
 
@@ -145,7 +145,7 @@ BPositionIO::~BPositionIO()
 
 
 ssize_t
-BPositionIO::Read(void *buffer, size_t size)
+BPositionIO::Read(void* buffer, size_t size)
 {
        off_t curPos = Position();
        ssize_t result = ReadAt(curPos, buffer, size);
@@ -157,7 +157,7 @@ BPositionIO::Read(void *buffer, size_t size)
 
 
 ssize_t
-BPositionIO::Write(const void *buffer, size_t size)
+BPositionIO::Write(const void* buffer, size_t size)
 {
        off_t curPos = Position();
        ssize_t result = WriteAt(curPos, buffer, size);
@@ -216,7 +216,7 @@ void BPositionIO::_ReservedPositionIO12(){}
 //     #pragma mark -
 
 
-BMemoryIO::BMemoryIO(void *buffer, size_t length)
+BMemoryIO::BMemoryIO(void* buffer, size_t length)
        :
        fReadOnly(false),
        fBuffer(static_cast<char*>(buffer)),
@@ -227,7 +227,7 @@ BMemoryIO::BMemoryIO(void *buffer, size_t length)
 }
 
 
-BMemoryIO::BMemoryIO(const void *buffer, size_t length)
+BMemoryIO::BMemoryIO(const void* buffer, size_t length)
        :
        fReadOnly(true),
        fBuffer(const_cast<char*>(static_cast<const char*>(buffer))),
@@ -244,7 +244,7 @@ BMemoryIO::~BMemoryIO()
 
 
 ssize_t
-BMemoryIO::ReadAt(off_t pos, void *buffer, size_t size)
+BMemoryIO::ReadAt(off_t pos, void* buffer, size_t size)
 {
        if (buffer == NULL || pos < 0)
                return B_BAD_VALUE;
@@ -254,12 +254,13 @@ BMemoryIO::ReadAt(off_t pos, void *buffer, size_t size)
                sizeRead = min_c((off_t)size, (off_t)fLength - pos);
                memcpy(buffer, fBuffer + pos, sizeRead);
        }
+
        return sizeRead;
 }
 
 
 ssize_t
-BMemoryIO::WriteAt(off_t pos, const void *buffer, size_t size)
+BMemoryIO::WriteAt(off_t pos, const void* buffer, size_t size)
 {
        if (fReadOnly)
                return B_NOT_ALLOWED;
@@ -296,6 +297,7 @@ BMemoryIO::Seek(off_t position, uint32 seek_mode)
                default:
                        break;
        }
+
        return fPosition;
 }
 
@@ -317,6 +319,7 @@ BMemoryIO::SetSize(off_t size)
                return B_ERROR;
 
        fLength = size;
+
        return B_OK;
 }
 
@@ -363,7 +366,7 @@ BMallocIO::~BMallocIO()
 
 
 ssize_t
-BMallocIO::ReadAt(off_t pos, void *buffer, size_t size)
+BMallocIO::ReadAt(off_t pos, void* buffer, size_t size)
 {
        if (buffer == NULL)
                return B_BAD_VALUE;
@@ -373,12 +376,13 @@ BMallocIO::ReadAt(off_t pos, void *buffer, size_t size)
                sizeRead = min_c((off_t)size, (off_t)fLength - pos);
                memcpy(buffer, fData + pos, sizeRead);
        }
+
        return sizeRead;
 }
 
 
 ssize_t
-BMallocIO::WriteAt(off_t pos, const void *buffer, size_t size)
+BMallocIO::WriteAt(off_t pos, const void* buffer, size_t size)
 {
        if (buffer == NULL)
                return B_BAD_VALUE;
@@ -394,6 +398,7 @@ BMallocIO::WriteAt(off_t pos, const void *buffer, size_t 
size)
                if (pos + size > fLength)
                        fLength = pos + size;
        }
+
        return error != B_OK ? error : size;
 }
 
@@ -439,7 +444,7 @@ BMallocIO::SetSize(off_t size)
                size_t newSize = (size + fBlockSize - 1) / fBlockSize * 
fBlockSize;
                if (size != (off_t)fMallocSize) {
                        // we need to resize
-                       if (char *newData = static_cast<char*>(realloc(fData, 
newSize))) {
+                       if (char* newData = static_cast<char*>(realloc(fData, 
newSize))) {
                                // set the new area to 0
                                if (newSize > fMallocSize)
                                        memset(newData + fMallocSize, 0, 
newSize - fMallocSize);
@@ -462,12 +467,13 @@ BMallocIO::SetBlockSize(size_t blockSize)
 {
        if (blockSize == 0)
                blockSize = 1;
+
        if (blockSize != fBlockSize)
                fBlockSize = blockSize;
 }
 
 
-const void *
+const void*
 BMallocIO::Buffer() const
 {
        return fData;
diff --git a/src/kits/support/DateTime.cpp b/src/kits/support/DateTime.cpp
index aa4aaf6..3d4a051 100644
--- a/src/kits/support/DateTime.cpp
+++ b/src/kits/support/DateTime.cpp
@@ -1,10 +1,10 @@
 /*
- * Copyright 2007-2010, Haiku, Inc. All Rights Reserved.
+ * Copyright 2007-2010 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  *
  * Authors:
- *             Julun <host.haiku@xxxxxx>
- *             Stephan Aßmus <superstippi@xxxxxx>
+ *             Stephan Aßmus, superstippi@xxxxxx
+ *             Julun, host.haiku@xxxxxx
  */
 
 #include "DateTime.h"
@@ -18,7 +18,6 @@
 
 namespace BPrivate {
 
-
 const int32                    kSecondsPerMinute                       = 60;
 
 const int32                    kHoursPerDay                            = 24;
@@ -1496,5 +1495,4 @@ BDateTime::operator>=(const BDateTime& dateTime) const
        return false;
 }
 
-
-}      //namespace BPrivate
+}      /* namespace BPrivate */
diff --git a/src/kits/support/List.cpp b/src/kits/support/List.cpp
index 641fcfc..a9788d1 100644
--- a/src/kits/support/List.cpp
+++ b/src/kits/support/List.cpp
@@ -1,12 +1,13 @@
 /*
- * Copyright 2001-2009, Haiku, Inc. All Rights Reserved.
+ * Copyright 2001-2014 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  *
  * Authors:
- *             The Storage kit Team
- *             Isaac Yonemoto
- *             Rene Gollent
+ *             The Storage Kit Team
  *             Stephan Aßmus
+ *             Rene Gollent
+ *             John Scipione, jscipione@xxxxxxxxx
+ *             Isaac Yonemoto
  */
 
 //!    BList class provides storage for pointers. Not thread safe.
@@ -42,14 +43,14 @@ BList::BList(int32 count)
 }
 
 
-BList::BList(const BList& anotherList)
+BList::BList(const BList& other)
        :
        fObjectList(NULL),
        fPhysicalSize(0),
        fItemCount(0),
-       fBlockSize(anotherList.fBlockSize)
+       fBlockSize(other.fBlockSize)
 {
-       *this = anotherList;
+       *this = other;
 }
 
 
@@ -60,13 +61,13 @@ BList::~BList()
 
 
 BList&
-BList::operator=(const BList& list)
+BList::operator=(const BList& other)
 {
-       if (&list != this) {
-               fBlockSize = list.fBlockSize;
-               if (_ResizeArray(list.fItemCount)) {
-                       fItemCount = list.fItemCount;
-                       memcpy(fObjectList, list.fObjectList, fItemCount * 
sizeof(void*));
+       if (&other != this) {
+               fBlockSize = other.fBlockSize;
+               if (_ResizeArray(other.fItemCount)) {
+                       fItemCount = other.fItemCount;
+                       memcpy(fObjectList, other.fObjectList, fItemCount * 
sizeof(void*));
                }
        }
 
@@ -75,16 +76,16 @@ BList::operator=(const BList& list)
 
 
 bool
-BList::operator==(const BList& list) const
+BList::operator==(const BList& other) const
 {
-       if (&list == this)
+       if (&other == this)
                return true;
 
-       if (list.fItemCount != fItemCount)
+       if (other.fItemCount != fItemCount)
                return false;
 
        if (fItemCount > 0) {
-               return memcmp(fObjectList, list.fObjectList,
+               return memcmp(fObjectList, other.fObjectList,
                        fItemCount * sizeof(void*)) == 0;
        }
 
@@ -93,9 +94,9 @@ BList::operator==(const BList& list) const
 
 
 bool
-BList::operator!=(const BList& list) const
+BList::operator!=(const BList& other) const
 {
-       return !(*this == list);
+       return !(*this == other);
 }
 
 
@@ -143,6 +144,7 @@ BList::AddList(const BList* list, int32 index)
                int32 count = list->fItemCount;
                if (fItemCount + count > fPhysicalSize)
                        result = _ResizeArray(fItemCount + count);
+
                if (result) {
                        fItemCount += count;
                        move_items(fObjectList + index, count, fItemCount - 
index - count);
@@ -150,6 +152,7 @@ BList::AddList(const BList* list, int32 index)
                                list->fItemCount * sizeof(void*));
                }
        }
+
        return result;
 }
 
@@ -163,12 +166,14 @@ BList::AddList(const BList* list)
                int32 count = list->fItemCount;
                if (fItemCount + count > fPhysicalSize)
                        result = _ResizeArray(fItemCount + count);
+
                if (result) {
                        fItemCount += count;
                        memcpy(fObjectList + index, list->fObjectList,
                                list->fItemCount * sizeof(void*));
                }
        }
+
        return result;
 }
 
@@ -220,12 +225,12 @@ BList::RemoveItems(int32 index, int32 count)
 
 
 bool
-BList::ReplaceItem(int32 index, void* newItem)
+BList::ReplaceItem(int32 index, void* item)
 {
        bool result = false;
 
        if (index >= 0 && index < fItemCount) {
-               fObjectList[index] = newItem;
+               fObjectList[index] = item;
                result = true;
        }
        return result;
@@ -278,22 +283,20 @@ BList::SwapItems(int32 indexA, int32 indexB)
        A C D E F G B H I J
 */
 bool
-BList::MoveItem(int32 fromIndex, int32 toIndex)
+BList::MoveItem(int32 from, int32 to)
 {
-       if ((fromIndex >= fItemCount) || (toIndex >= fItemCount) || (fromIndex 
< 0)
-               || (toIndex < 0)) {
+       if ((from >= fItemCount) || (to >= fItemCount) || (from < 0) || (to < 
0))
                return false;
-       }
 
-       void* tmpMover = fObjectList[fromIndex];
-       if (fromIndex < toIndex) {
-               memmove(fObjectList + fromIndex, fObjectList + fromIndex + 1,
-                       (toIndex - fromIndex) * sizeof(void*));
-       } else if (fromIndex > toIndex) {
-               memmove(fObjectList + toIndex + 1, fObjectList + toIndex,
-                       (fromIndex - toIndex) * sizeof(void*));
-       };
-       fObjectList[toIndex] = tmpMover;
+       void* tmpMover = fObjectList[from];
+       if (from < to) {
+               memmove(fObjectList + from, fObjectList + from + 1,
+                       (to - from) * sizeof(void*));
+       } else if (from > to) {
+               memmove(fObjectList + to + 1, fObjectList + to,
+                       (from - to) * sizeof(void*));
+       }
+       fObjectList[to] = tmpMover;
 
        return true;
 }
@@ -305,7 +308,7 @@ BList::MoveItem(int32 fromIndex, int32 toIndex)
 void*
 BList::ItemAt(int32 index) const
 {
-       void *item = NULL;
+       void* item = NULL;
        if (index >= 0 && index < fItemCount)
                item = fObjectList[index];
        return item;
@@ -315,7 +318,7 @@ BList::ItemAt(int32 index) const
 void*
 BList::FirstItem() const
 {
-       void *item = NULL;
+       void* item = NULL;
        if (fItemCount > 0)
                item = fObjectList[0];
        return item;
@@ -467,8 +470,7 @@ void BList::_ReservedList1() {}
 void BList::_ReservedList2() {}
 
 
-/*!    Resizes fObjectList to be large enough to contain count items.
-*/
+//!    Resizes fObjectList to be large enough to contain count items.
 bool
 BList::_ResizeArray(int32 count)
 {
@@ -480,12 +482,12 @@ BList::_ResizeArray(int32 count)
        int32 targetSize = count;
        if (targetSize <= 0)
                targetSize = fBlockSize;
+
        if (targetSize > fPhysicalSize) {
                while (newSize < targetSize)
                        newSize <<= 1;
-       } else if (targetSize <= fResizeThreshold) {
+       } else if (targetSize <= fResizeThreshold)
                newSize = fResizeThreshold;
-       }
 
        // resize if necessary
        if (newSize != fPhysicalSize) {
@@ -501,6 +503,6 @@ BList::_ResizeArray(int32 count)
                } else
                        result = false;
        }
+
        return result;
 }
-
diff --git a/src/kits/support/Locker.cpp b/src/kits/support/Locker.cpp
index 13c3bc3..630c22e 100644
--- a/src/kits/support/Locker.cpp
+++ b/src/kits/support/Locker.cpp
@@ -1,9 +1,9 @@
 /*
- * Copyright 2001-2009, Haiku, Inc.
+ * Copyright 2001-2009 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT license.
  *
  * Authors:
- *             Erik Jaesler <erik@xxxxxxxxxxxxxx>
+ *             Erik Jaesler, erik@xxxxxxxxxxxxxx
  */
 
 
diff --git a/src/kits/support/String.cpp b/src/kits/support/String.cpp
index 6e06c22..38a5747 100644
--- a/src/kits/support/String.cpp
+++ b/src/kits/support/String.cpp
@@ -1,14 +1,14 @@
 /*
- * Copyright 2001-2010, Haiku, Inc. All Rights Reserved.
+ * Copyright 2001-2014 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  *
  * Authors:
- *             Marc Flerackers (mflerackers@xxxxxxxxxx)
- *             Stefano Ceccherini (burton666@xxxxxxxxx)
- *             Oliver Tappe (openbeos@xxxxxxxxxxxxxxx)
+ *             Stefano Ceccherini, burton666@xxxxxxxxx
  *             Axel Dörfler, axeld@xxxxxxxxxxxxxxxx
- *             Julun <host.haiku@xxxxxx>
- *             Michael Lotz <mmlr@xxxxxxxx>
+ *             Marc Flerackers, mflerackers@xxxxxxxxxx
+ *             Julun, host.haiku@xxxxxx
+ *             Michael Lotz, mmlr@xxxxxxxx
+ *             Oliver Tappe, openbeos@xxxxxxxxxxxxxxx
  */
 
 
@@ -54,10 +54,10 @@ min_clamp0(int32 num1, int32 num2)
 
 //! Returns length of given string (but clamps to given maximum).
 static inline int32
-strlen_clamp(const char* str, int32 max)
+strlen_clamp(const char* string, int32 max)
 {
        // this should yield 0 for max<0:
-       return max <= 0 ? 0 : strnlen(str, max);
+       return max <= 0 ? 0 : strnlen(string, max);
 }
 
 
@@ -71,9 +71,9 @@ string_length(const char* string)
 
 //! helper function, massages given pointer into a legal c-string:
 static inline const char*
-safestr(const char* str)
+safestr(const char* string)
 {
-       return str ? str : "";
+       return string != NULL ? string : "";
 }
 
 
@@ -110,6 +110,7 @@ public:
                }
 
                fBuffer[fSize++] = pos;
+
                return true;
        }
 
@@ -134,7 +135,8 @@ private:
 
 
 BStringRef::BStringRef(BString& string, int32 position)
-       : fString(string), fPosition(position)
+       :
+       fString(string), fPosition(position)
 {
 }
 
diff --git a/src/kits/support/Url.cpp b/src/kits/support/Url.cpp
index dd59207..bfe9965 100644
--- a/src/kits/support/Url.cpp
+++ b/src/kits/support/Url.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright 2007-2009 Haiku Inc. All rights reserved.
+ * Copyright 2007-2009 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  *
  * Authors:
@@ -275,7 +275,5 @@ BUrl::Path() const
        return fPath;
 }
 
-
 } // namespace Support
 } // namespace BPrivate
-
diff --git a/src/kits/support/Uuid.cpp b/src/kits/support/Uuid.cpp
index 23fd3c7..bc08a00 100644
--- a/src/kits/support/Uuid.cpp
+++ b/src/kits/support/Uuid.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013, Haiku, Inc.
+ * Copyright 2013 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 
@@ -32,13 +32,13 @@ init_random_seed()
        seed ^= (uint32)(addr_t)&time;
 
        srandom(seed);
+
        return true;
 }
 
 
 namespace BPrivate {
 
-
 BUuid::BUuid()
 {
        memset(fValue, 0, sizeof(fValue));
@@ -93,6 +93,7 @@ BUuid::ToString() const
                buffer[2 * i] = kHexChars[fValue[i] >> 4];
                buffer[2 * i + 1] = kHexChars[fValue[i] & 0xf];
        }
+
        return BString().SetToFormat("%.8s-%.4s-%.4s-%.4s-%.12s",
                buffer, buffer + 8, buffer + 12, buffer + 16, buffer + 20);
 }
@@ -109,6 +110,7 @@ BUuid&
 BUuid::operator=(const BUuid& other)
 {
        memcpy(fValue, other.fValue, sizeof(fValue));
+
        return *this;
 }
 
@@ -153,7 +155,6 @@ BUuid::_SetToRandomFallback()
                fValue[4 * i] |= (bitsToMove << i) & 0x80;
 }
 
-
 }      // namespace BPrivate
 
 

############################################################################

Revision:    hrev47422
Commit:      c4b9309a9964a8bf18a834cf41aa97f1172bab0d
URL:         http://cgit.haiku-os.org/haiku/commit/?id=c4b9309
Author:      John Scipione <jscipione@xxxxxxxxx>
Date:        Tue Jun 24 23:25:43 2014 UTC

Update Support Kit docs, add \since

Also add preliminary documentation for BObjectList.

----------------------------------------------------------------------------

diff --git a/docs/user/support/Architecture.dox 
b/docs/user/support/Architecture.dox
index 699beac..8b7c38a 100644
--- a/docs/user/support/Architecture.dox
+++ b/docs/user/support/Architecture.dox
@@ -1,13 +1,14 @@
 /*
- * Copyright 2013, Haiku, Inc. All rights reserved.
+ * Copyright 2013-2014 Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  *
  * Documentation by:
+ *             John Scipione, jscipione@xxxxxxxxx
  *             Ingo Weinhold, ingo_weinhold@xxxxxx
  *
  * Corresponds to:
- *             headers/os/storage/PathFinder.h  hrev46390
- *             src/kits/storage/PathFinder.cpp  hrev46390
+ *             headers/os/support/Architecture.h        hrev47419
+ *             src/kits/support/Architecture.cpp        hrev47419
  */
 
 
@@ -16,7 +17,7 @@
        \ingroup support
        \ingroup libbe
        \brief Provides functions for getting the primary and secondary
-               architectures of the system.
+              architectures of the system.
 */
 
 
@@ -30,6 +31,8 @@
        \return The name of the caller's architecture.
 
        \see get_primary_architecture()
+
+       \since Haiku R1
 */
 
 
@@ -40,6 +43,8 @@
        This is the packaging architecture the main system has been built for.
 
        \return The name of the system's primary architecture.
+
+       \since Haiku R1
 */
 
 
@@ -56,12 +61,15 @@
        if it would be possible to install the support for gcc 4.
 
        \param architectures A pre-allocated array of size \a count where the 
names
-               of the secondary architectures will be stored. Can be \c NULL, 
if
-               \a count is 0.
+              of the secondary architectures will be stored. Can be \c NULL, if
+              \a count is 0.
        \param count The size of the \a architectures array.
+
        \return The actual number of secondary architectures. May be greater 
than
-               \a count, but at most \a count names will be written to
-               \a architectures.
+               \a count, but at most \a count names will be written to
+               \a architectures.
+
+       \since Haiku R1
 */
 
 
@@ -75,13 +83,16 @@
        Note that this version can fail when running out of memory.
 
        \param _architectures Reference to a BStringList that will be set to the
-               list of names of secondary architectures. On error the list 
will be
-               emptied.
+              list of names of secondary architectures. On error the list will 
be
+              emptied.
+
        \return A status code.
        \retval B_OK Everything went fine.
        \retval B_NO_MEMORY A memory allocation failed.
 
        \see get_secondary_architectures(const char**,size_t)
+
+       \since Haiku R1
 */
 
 
@@ -89,24 +100,24 @@
        \fn size_t get_architectures(const char** architectures,
                size_t count)
        \brief Returns the names of the system's primary and secondary
-               architectures.
+              architectures.
 
        This is a convenience function that returns both the primary 
architecture
        as returned by get_primary_architecture() and the secondary 
architectures
        as returned by get_secondary_architectures() in the provided array.
 
        \param architectures A pre-allocated array of size \a count where the 
names
-               of the architectures will be stored. Can be \c NULL, if \a 
count is 0.
+              of the architectures will be stored. Can be \c NULL if \a count 
is 0.
        \param count The size of the \a architectures array.
        \return The actual number of architectures. May be greater than \a 
count,
-               but at most \a count names will be written to \a architectures.
+               but at most \a count names will be written to \a architectures.
 */
 
 
 /*!
        \fn status_t get_architectures(BStringList& _architectures)
        \brief Returns the names of the system's primary and secondary
-               architectures.
+              architectures.
 
        This is a C++ interface similar to
        get_architectures(const char**,size_t). Instead of returning the
@@ -114,13 +125,16 @@
        Note that this version can fail when running out of memory.
 
        \param _architectures Reference to a BStringList that will be set to the
-               list of names of primary and secondary architectures. On error 
the list
-               will be emptied.
+              list of names of primary and secondary architectures. On error 
the
+              list will be emptied.
+
        \return A status code.
        \retval B_OK Everything went fine.
        \retval B_NO_MEMORY A memory allocation failed.
 
        \see get_architectures(const char**,size_t)
+
+       \since Haiku R1
 */
 
 
@@ -135,6 +149,9 @@
        inconclusive the name of the primary architecture is returned.
 
        \param path The path to be analyzed. It doesn't necessarily have to 
point to
-               an existing file or directory.
+              an existing file or directory.
+
        \return The name of the architecture determined from \a path.
+
+       \since Haiku R1
 */
diff --git a/docs/user/support/Archivable.dox b/docs/user/support/Archivable.dox
index e11b97f..b8db3c2 100644
--- a/docs/user/support/Archivable.dox
+++ b/docs/user/support/Archivable.dox
@@ -5,6 +5,7 @@
  * Authors:
  *             Niels Sascha Reedijk, niels.reedijk@xxxxxxxxx
  *             Alex Wilson, yourpalal2@xxxxxxxxx
+ *             John Scipione, jscipione@xxxxxxxxx
  *
  * Proofreader:
  *             David Weizades, ddewbofh@xxxxxxxxxxx
@@ -21,7 +22,7 @@
        \ingroup support
        \ingroup libbe
        \brief Provides the BArchivable interface and declares the BArchiver and
-               BUnarchiver classes.
+              BUnarchiver classes.
 */
 
 
@@ -64,6 +65,8 @@
        You should also consider implementing the AllArchived() and 
AllUnarchived()
        methods, which were designed to ease archiving and unarchiving in such
        a situation.
+
+       \since BeOS R3
 */
 
 
@@ -76,36 +79,43 @@
        that takes one BMessage argument. In that constructor, you should call 
        your parent class' archive constructor (even if your parent class is
        BArchivable).
+
+       \since BeOS R3
 */
 
 
 /*!
        \fn BArchivable::BArchivable()
        \brief Constructor. Does nothing.
+
+       \since BeOS R3
 */
 
 
 /*!
        \fn BArchivable::~BArchivable()
        \brief Destructor. Does nothing.
+
+       \since BeOS R3
 */
 
 
 /*!
-       \fn virtual status_t BArchivable::Archive(BMessage* into,
-                bool deep = true) const
+       \fn virtual status_t BArchivable::Archive(BMessage* into, bool deep) 
const
        \brief Archive the object into a BMessage.
-       
+
        You should call this method from your derived implementation as it adds 
the
        data needed to instantiate your object to the message.
-       
+
        \param into The message you store your object in.
        \param deep If \c true, all children of this object should be archived 
as
-               well.
+              well.
 
        \retval B_OK The archive operation was successful.
        \retval B_BAD_VALUE \c NULL \a archive message.
        \retval B_ERROR The archive operation failed.
+
+       \since BeOS R3
 */
 
 
@@ -117,17 +127,22 @@
        your class. The automatic functions, such as #instantiate_object() and
        BUnarchiver::InstantiateObject() will not choose the wrong class but 
manual
        calls to this member might be faulty. You can verify that \c archive
-       stores an object of your calss with the validate_instantiation() 
function.
+       stores an object of your class with the validate_instantiation() 
function.
 
        \param archive The message with the data of the object to restore.
+
+       \return A pointer to a BArchivable object.
        \retval You should return a pointer to the object you create with
-               \c archive, or \c NULL if unarchival fails.
+               \c archive, or \c NULL if the unarchival fails.
+
        \warning The default implementation will always return \c NULL. Even 
though
                it is possible to store plain BArchivable objects, it is 
impossible to
-               restore them. 
+               restore them.
 
-       \see instantiate_object(BMessage *from)
+       \see instantiate_object(BMessage*)
        \see BUnarchiver::InstantiateObject()
+
+       \since BeOS R3
 */
 
 
@@ -137,13 +152,16 @@
                   compatibility purposes).
 
        \internal This method is defined for binary compatibility purposes, it 
is
-               used to ensure that the correct AllUnarchived() and 
AllArchived()
-               methods are called for objects, as those methods are new to 
Haiku.
+                 used to ensure that the correct AllUnarchived() and 
AllArchived()
+                 methods are called for objects, as those methods are new to
+                 Haiku.
 
        \param d The perform code.
        \param arg A pointer to store some data.
 
        \returns A status code.
+
+       \since Haiku R1
 */
 
 
@@ -158,10 +176,12 @@
        their parent class, the same as for the Archive() method.
 
        \warning To guarantee that your AllUnarchived() method will be called
-               during unarchival, you must create a BUnarchiver object in your
-               archive constructor.
+                during unarchival, you must create a BUnarchiver object in your
+                archive constructor.
 
        \see BUnarchiver, BUnarchiver::Finish()
+
+       \since Haiku R1
 */
 
 
@@ -184,6 +204,8 @@
                method implementation, and \b NOT your AllArchived() method.
 
        \see BArchiver BArchiver::Finish()
+
+       \since Haiku R1
 */
 
 
@@ -195,7 +217,7 @@
        \ingroup support
        \ingroup libbe
        \brief A class that simplifies the archiving of complicated BArchivable
-               hierarchies.
+              hierarchies.
 
        The BArchiver class is a small class that is used for archiving of
        complicated BArchivable hierarchies. Such a hierarchy may include
@@ -208,19 +230,25 @@
        present in your original hierarchy.
 
        The objects you archive can be retrieved using a BUnarchiver object.
+
+       \since Haiku R1
 */
 
 
 /*!
        \fn BArchiver::BArchiver(BMessage* archive)
        \brief Constructs a BArchiver object that manages \c archive.
+
+       \since Haiku R1
 */
 
 
 /*!
        \fn BArchiver::~BArchiver()
        \brief Destroys a BArchiver object. If the BArchiver object has not had 
its
-       Finish() method called, this will be done now.
+              Finish() method called, this will be done now.
+
+       \since Haiku R1
 */
 
 
@@ -228,12 +256,12 @@
        \fn status_t BArchiver::AddArchivable(const char* name,
                        BArchivable* archivable, bool deep = true)
        \brief Adds a reference to \c archivable to the archive used to
-               construct this BArchiver. May call \c archivable's Archive() 
method.
+              construct this BArchiver. May call \c archivable's Archive() 
method.
 
        \param name Where this reference will be stored in the archive.
        \param archivable The BArchivable* object that to reference.
        \param deep Passed to \c archivable->Archive() if \c archivable must
-               be archived.
+              be archived.
 
        Adds a reference to \c archivable to your archive. If \c archivable has
        not yet been archived, then its Archive() method is called. BArchiver
@@ -241,9 +269,11 @@
        method or the GetTokenForArchivable() methods.
 
        \warning If you manually archive an object, and then pass it to
-               AddArchivable() or GetTokenForArchivable(), it will be archived 
again,
-               and when unarchived you will end up with two different 
BArchivable
-               objects.
+                AddArchivable() or GetTokenForArchivable(), it will be archived
+                again, and when unarchived you will end up with two different
+                BArchivable objects.
+
+       \since Haiku R1
 */
 
 
@@ -251,12 +281,12 @@
        \fn status_t BArchiver::GetTokenForArchivable(BArchivable* archivable,
                bool deep, int32& _token);
        \brief Get a token representing a BArchivable object for this archiving
-               session.
+              session.
 
        \param archivable The BArchivable object for which you wish to get a
-               token.
+              token.
        \param deep Controls how \c archivable will be archived, if it has not 
yet
-               been archived in this session.
+              been archived in this session.
        \param[out] _token The token representing \c archivable is stored here.
 
        Retrieves or creates a token to represent \c archivable in this 
archiving
@@ -265,8 +295,10 @@
        Archive() method.
 
        \warning If you manually archive an object, and then pass it to
-               GetTokenForArchivable(), it will be archived again, and when 
unarchived
-               you will end up with two different BArchivable objects.
+                GetTokenForArchivable(), it will be archived again, and when
+                unarchived you will end up with two different BArchivable 
objects.
+
+       \since Haiku R1
 */
 
 
@@ -274,46 +306,58 @@
        \fn status_t BArchiver::GetTokenForArchivable(BArchivable* archivable,
                int32 &_token)
        \brief Equivalent to calling the expanded GetTokenForArchivable(
-               BArchivable*, bool, int32&), with the deep parameter equal to 
true.
+              BArchivable*, bool, int32&), with the deep parameter equal to
+              \c true.
 
        \see GetTokenForArchivable(BArchivable*, bool, int32&)
+
+       \since Haiku R1
 */
 
 
 /*!
        \fn bool BArchiver::IsArchived(BArchivable* archivable);
        \brief Returns whether \c archivable has already been archived in this
-               session.
+              session.
 
+       \return Whether or not the object has already been archived.
        \retval true \c archivable has been archived in this archiving session.
        \retval false \c archivable has not been archived in this archiving 
session.
+
+       \since Haiku R1
 */
 
 
 /*!
        \fn status_t BArchiver::Finish(status_t err = B_OK);
        \brief Report any archiving errors and possibly complete the archiving
-               session.
-       \return The first error reported in this archiving session, or B_OK.
+              session.
 
        This method may finish an archiving session (triggering the call of all
        archived objects' AllArchived() methods) if the following conditions
        are true:
-       \li No errors have been reported to this or any other BArchiver object
-               within this session.
-       \li This is the last remaining BArchiver that has not had its Finish()
-               method invoked.
+       - No errors have been reported to this or any other BArchiver object
+         within this session.
+       - This is the last remaining BArchiver that has not had its Finish()
+         method invoked.
+
        If you call this method with an error code not equal to B_OK, then this
        archiving session has failed, archived objects will not have their
        AllArchived() methods called, and any subsequent calls to this method
        on any BArchiver objects in this session will return your error code.
+
+       \return The first error reported in this archiving session, or \c B_OK.
+
+       \since Haiku R1
 */
 
 
 /*!
-       \fn     const BMessage* BArchiver::ArchiveMessage() const
+       \fn const BMessage*     BArchiver::ArchiveMessage() const
        \brief Returns the BMessage* used to construct this BArchiver. This is
-               the archive that AddArchivable() modifies.
+              the archive that AddArchivable() modifies.
+
+       \since Haiku R1
 */
 
 
@@ -325,7 +369,7 @@
        \ingroup support
        \ingroup libbe
        \brief A class that simplifies the unarchiving of complicated 
BArchivable
-                  hierarchies.
+              hierarchies.
 
        The BUnarchiver class is a small class used to recover BArchivable 
objects
        that have been archived with the BArchiver class. It also provides 
ownership
@@ -343,9 +387,11 @@
        BUnarchiver helper classes, and want to maintain backwards compatibility
        with old archive, this can be done using the IsArchiveManaged() method. 
 
-       \warning Calling methods on your BUnarchiver with a legacy archive (one 
that
-               was not managed by a BArchiver during archival) will result in a
-               call to debugger().
+       \warning Calling methods on your BUnarchiver with a legacy archive (one
+                that was not managed by a BArchiver during archival) will 
result
+                in a call to debugger().
+
+       \since Haiku R1
 */
 
 
@@ -354,15 +400,18 @@
        \brief Constructs a BUnarchiver object to manage \c archive.
 
        \note To guarantee that your AllUnarchived() method will be called 
during
-               archival, you must create a BUnarchiver object in your archive
-               constructor. It is necessary to do this even if you won't use 
the
-               BUnarchiver object in your archive constructor.
+             archival, you must create a BUnarchiver object in your archive
+             constructor. It is necessary to do this even if you won't use the
+             BUnarchiver object in your archive constructor.
 
        \warning Do not construct a BUnarchiver object without first calling
-               BUnarchiver::PrepareArchive() on \c archive. It is only safe to 
build a
-               BUnarchiver without this call in your AllUnarchived() 
implementation. 
+                BUnarchiver::PrepareArchive() on \c archive. It is only safe to
+                build a BUnarchiver without this call in your AllUnarchived()
+                implementation.
 
        \see BUnarchiver::PrepareArchive()
+
+       \since Haiku R1
 */
 
 
@@ -371,17 +420,21 @@
        \brief Destroys a BUnarchiver object.
 
        Calls this objects Finish() method, if it has not yet been called.
+
+       \since Haiku R1
 */
 
 
 /*!
        \fn status_t BUnarchiver::EnsureUnarchived(int32 token)
        \brief Ensure the object represented by \a token is unarchived and
-               instantiated.
+              instantiated.
 
        \param token the object \a token
 
        \returns A status code.
+
+       \since Haiku R1
 */
 
 
@@ -389,35 +442,41 @@
        \fn status_t BUnarchiver::EnsureUnarchived(const char* name,
                int32 index = 0)
        \brief Ensure the object archived under \a name at \a index is 
unarchived
-               and instantiated.
+              and instantiated.
 
        \param name The archive \a name.
        \param index The archive \a index.
 
        \returns A status code.
+
+       \since Haiku R1
 */
 
 
 /*!
        \fn bool BUnarchiver::IsInstantiated(int32 token)
        \brief Checks whether the object represented by \c token has been
-               instantiated in this session.
+              instantiated in this session.
 
        \param token The object \a token.
 
        \returns \c true if instantiated, \c false otherwise
+
+       \since Haiku R1
 */
 
 
 /*!
        \fn bool BUnarchiver::IsInstantiated(const char* name, int32 index = 0)
        \brief Checks whether the object archived under \a name at \a index has 
been
-               instantiated in this session.
+              instantiated in this session.
 
        \param name The archive \a name.
        \param index The arcive \a token.
 
        \returns \c true if instantiated, \c false otherwise.
+
+       \since Haiku R1
 */
 
 
@@ -431,18 +490,20 @@
        If the retrieved object is not of the type T, then this method will 
fail.
        If this method fails, you will not receive ownership of the object, no
        matter what you specified in \c owning.
-       
+
        \tparam T The type of \a object you wish to find.
 
        \param token The \a token you got for this object from
-               BArchiver::GetTokenForArchivable() during archival.
+              BArchiver::GetTokenForArchivable() during archival.
        \param owning Whether or not you wish to take ownership of the
-               retrieved object.
+              retrieved object.
        \param object Return parameter for the retrieved object of type T.
 
        \returns A status code.
        \retval B_OK The object retrieved was of type T.
        \retval B_BAD_TYPE The object retrieved was not of type T.
+
+       \since Haiku R1
 */
 
 
@@ -456,12 +517,14 @@
        \tparam T The type of \a object you wish to find.
 
        \param token The \a token you got for this object from
-               BArchiver::GetTokenForArchivable() during archival.
+              BArchiver::GetTokenForArchivable() during archival.
        \param object The return parameter for the retrieved object of type T.
 
        \returns A status code.
        \retval B_OK The object retrieved was of type T.
        \retval B_BAD_TYPE The object retrieved was not of type T.
+
+       \since Haiku R1
 */
 
 
@@ -469,7 +532,7 @@
        \fn template<class T> status_t BUnarchiver::FindObject(const char* name,
                int32 index, ownership_policy owning, T*& object)
        \brief Recover an object that had previously been archived using
-               the BArchiver::AddArchivable() method.
+              the BArchiver::AddArchivable() method.
 
        If the object has not yet been instantiated, and this request is not
        coming from an AllUnarchived() implementation, the object will be
@@ -478,20 +541,22 @@
        If the retrieved object is not of the type T, then this method will 
fail.
        If this method fails, you will not receive ownership of the object, no
        matter what you specified in \c owning.
-       
+
        \tparam T The type of object you wish to find.
 
        \param name The name that was passed to BArchiver::AddArchivable() when
-               adding this object.
+              adding this object.
        \param index The index of the object you wish to recover (\c 0-based,
-               like BMessage::FindData().
+              like BMessage::FindData().
        \param owning Dictates whether or not you wish to take ownership of the
-               retrieved object.
+              retrieved object.
        \param object Return parameter for the retrieved object of type T.
 
        \returns A status code.
        \retval B_OK The object retrieved was of type T.
        \retval B_BAD_TYPE The object retrieved was not of type T.
+
+       \since Haiku R1
 */
 
 
@@ -499,19 +564,21 @@
        \fn template<class T> status_t BUnarchiver::FindObject(const char* name,
                int32 index, T*& object)
        \brief Recover and take ownership of an object that had previously been
-               archived using the BArchiver::AddArchivable() method.
+              archived using the BArchiver::AddArchivable() method.
 
        \tparam T The type of object you wish to find.
 
        \param name The name that was passed to BArchiver::AddArchivable() when
-               adding this object.
+              adding this object.
        \param index The index of the object you wish to recover (\c 0-based,
-               like #BMessage::FindData().
+              like #BMessage::FindData().
        \param object Return parameter for the retrieved object of type T.
 
        \returns A status code.
        \retval B_OK The object retrieved was of type T.
        \retval B_BAD_TYPE The object retrieved was not of type T.
+
+       \since Haiku R1
 */
 
 
@@ -519,21 +586,23 @@
        \fn template<class T> status_t BUnarchiver::FindObject(const char* name,
                ownership_policy owning, T*& object)
        \brief Recover an object at index \c 0 that had previously been
-               archived using the BArchiver::AddArchivable() method.
+              archived using the BArchiver::AddArchivable() method.
 
        Equivalent to calling FindObject(name, \c 0, owning, object).
 
        \tparam T The type of \a object you wish to find.
 
        \param name The name that was passed to BArchiver::AddArchivable() when
-               adding this object.
+              adding this object.
        \param owning Dictates whether or not you wish to take ownership of the
-               retrieved object.
+              retrieved object.
        \param object Return parameter for the retrieved object of type T.
 
        \returns A status code.
        \retval B_OK The object retrieved was of type T.
        \retval B_BAD_TYPE The object retrieved was not of type T.
+
+       \since Haiku R1
 */
 
 
@@ -544,33 +613,35 @@
                previously been archived using the BArchiver::AddArchivable() 
method.
 
        Equivalent to calling FindObject(name, \c 0,
-               BUnarchiver::B_ASSUME_OWNERSHIP, object).
+       BUnarchiver::B_ASSUME_OWNERSHIP, object).
 
        \tparam T The type of \a object you wish to find.
 
        \param name The name that was passed to BArchiver::AddArchivable() when
-               adding this object.
+              adding this object.
        \param object Return parameter for the retrieved \a object of type T.
 
        \returns A status code.
        \retval B_OK The \a object retrieved was of type T.
        \retval B_BAD_TYPE The \a object retrieved was not of type T.
+
+       \since Haiku R1
 */
 
 
 /*!
        \fn status_t BUnarchiver::Finish(status_t err = B_OK);
        \brief Report any unarchiving errors and possibly complete the archiving
-               session.
+              session.
 
        This method may finish an unarchiving session (triggering the call of 
all
        instantiated objects' AllUnarchived() methods) if the following 
conditions
        are true:
 
-       \li No errors have been reported to this or any other BUnarchiver
-               object within this session.
-       \li This is the last remaining BUnarchiver that has not had its
-               Finish() method invoked.
+       - No errors have been reported to this or any other BUnarchiver
+         object within this session.
+       - This is the last remaining BUnarchiver that has not had its
+         Finish() method invoked.
 
        If you call this method with an error code not equal to B_OK, then this
        unarchiving session has failed, instantiated objects will not have their
@@ -581,11 +652,13 @@
        the root object).
 
        \return The first error reported in this unarchiving session, or \c 
B_OK.
+
+       \since Haiku R1
 */
 
 
 /*!
-       \fn     const BMessage* BUnarchiver::ArchiveMessage() const
+       \fn const BMessage* BUnarchiver::ArchiveMessage() const
        \brief Returns the BMessage* used to construct this BUnarchiver.
 
        This is the archive that FindObject() uses.
@@ -623,6 +696,8 @@ MyArchivableClas::MyArchivableClass(BMessage* archive)
        \returns Whether \a archive was managed by a BArchiver object.
        \retval true if \a archive was managed by a BArchiver object.
        \retval false otherwise.
+
+       \since Haiku R1
 */
 
 
@@ -650,6 +725,8 @@ MyArchivableClas::MyArchivableClas(BMessage* archive)
        \param archive The archive you wish to have prepared.
 
        \return The same #BMessage as is passed in.
+
+       \since Haiku R1
 */
 
 
@@ -661,16 +738,20 @@ MyArchivableClas::MyArchivableClas(BMessage* archive)
        \a archivable.
 
        \param archivable The \a archivable object.
+
+       \since Haiku R1
 */
 
 
 /*!
        \fn void BUnarchiver::RelinquishOwnership(BArchivable* archivable)
        \brief Relinquish ownership of \a archivable. If \a archivable remains
-               unclaimed at the end of the unarchiving session, it will be 
deleted
-               (unless it is the root object).
+              unclaimed at the end of the unarchiving session, it will be 
deleted
+              (unless it is the root object).
 
        \param archivable The \a archivable object.
+
+       \since Haiku R1
 */
 
 
@@ -678,7 +759,7 @@ MyArchivableClas::MyArchivableClas(BMessage* archive)
        \fn template<class T> status_t BUnarchiver::InstantiateObject(
                BMessage* from, T*& object)

[ *** diff truncated: 6975 lines dropped *** ]



Other related posts: