Assign class docs for app and support to libbe group, not libroot

This commit is contained in:
John Scipione
2013-02-07 15:04:05 -05:00
parent 30b280b217
commit 41611c9c5e
26 changed files with 48 additions and 46 deletions
+2 -2
View File
@@ -14,7 +14,7 @@
/*! /*!
\file Application.h \file Application.h
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief Provides the BApplication class. \brief Provides the BApplication class.
*/ */
@@ -22,7 +22,7 @@
/*! /*!
\class BApplication \class BApplication
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief A container object for an application. \brief A container object for an application.
A BApplication establishes a connection between the application and the A BApplication establishes a connection between the application and the
+2 -2
View File
@@ -15,7 +15,7 @@
/*! /*!
\file Clipboard.h \file Clipboard.h
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief Provides the BClipboard class. \brief Provides the BClipboard class.
*/ */
@@ -29,7 +29,7 @@
/*! /*!
\class BClipboard \class BClipboard
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief Used for short-term data storage between documents and \brief Used for short-term data storage between documents and
applications via copy and paste operations. applications via copy and paste operations.
+2 -2
View File
@@ -14,7 +14,7 @@
/*! /*!
\file Cursor.h \file Cursor.h
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief Provides the BCursor class. \brief Provides the BCursor class.
*/ */
@@ -202,7 +202,7 @@
/*! /*!
\class BCursor \class BCursor
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief BCursor describes a view-wide or application-wide cursor. \brief BCursor describes a view-wide or application-wide cursor.
\note As BeOS only supports 16x16 monochrome cursors, to see a nice \note As BeOS only supports 16x16 monochrome cursors, to see a nice
+2 -2
View File
@@ -13,7 +13,7 @@
/*! /*!
\file Handler.h \file Handler.h
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief Provides the BHandler class. \brief Provides the BHandler class.
*/ */
@@ -55,7 +55,7 @@
/*! /*!
\class BHandler \class BHandler
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief Handles messages that are passed on by a BLooper. \brief Handles messages that are passed on by a BLooper.
The BHandler class implements two important pieces of functionality. It The BHandler class implements two important pieces of functionality. It
+2 -2
View File
@@ -13,7 +13,7 @@
/*! /*!
\file Looper.h \file Looper.h
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief Provides the BLooper class. \brief Provides the BLooper class.
*/ */
@@ -27,7 +27,7 @@
/*! /*!
\class BLooper \class BLooper
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief Receive and process messages in a separate thread. \brief Receive and process messages in a separate thread.
When an object of this class is created, the message loop can be started When an object of this class is created, the message loop can be started
+4 -2
View File
@@ -14,12 +14,14 @@
/*! /*!
\file Message.h \file Message.h
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief Provides the BMessage class. \brief Provides the BMessage class.
*/ */
///// Name lengths and Scripting specifiers ///// ///// Name lengths and Scripting specifiers /////
/*! /*!
\def B_FIELD_NAME_LENGTH \def B_FIELD_NAME_LENGTH
\brief Undocumented... \brief Undocumented...
@@ -92,7 +94,7 @@
/*! /*!
\class BMessage \class BMessage
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief A container that can be send and received using the Haiku messaging \brief A container that can be send and received using the Haiku messaging
subsystem. subsystem.
+2 -2
View File
@@ -14,7 +14,7 @@
/*! /*!
\file MessageFilter.h \file MessageFilter.h
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief Provides BMessageFilter class. \brief Provides BMessageFilter class.
*/ */
@@ -143,7 +143,7 @@
/*! /*!
\class BMessageFilter \class BMessageFilter
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief Describes a message filter for BLooper and BHandler. \brief Describes a message filter for BLooper and BHandler.
Objects of this class serve as a description of properties that incoming Objects of this class serve as a description of properties that incoming
+2 -2
View File
@@ -13,7 +13,7 @@
/*! /*!
\file MessageQueue.h \file MessageQueue.h
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief Provides the BMessageQueue class. \brief Provides the BMessageQueue class.
*/ */
@@ -21,7 +21,7 @@
/*! /*!
\class BMessageQueue \class BMessageQueue
\ingroup app \ingroup app
\ingroup libroot \ingroup libbe
\brief A container that maintains a queue of messages. \brief A container that maintains a queue of messages.
This class is used by BLooper to maintain a queue of messages that need to This class is used by BLooper to maintain a queue of messages that need to
+2 -2
View File
@@ -19,7 +19,7 @@
/*! /*!
\file Archivable.h \file Archivable.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Provides the BArchivable interface and declares the BArchiver and \brief Provides the BArchivable interface and declares the BArchiver and
BUnarchiver classes. BUnarchiver classes.
*/ */
@@ -28,7 +28,7 @@
/*! /*!
\class BArchivable \class BArchivable
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Interface for objects that can be archived into a BMessage. \brief Interface for objects that can be archived into a BMessage.
BArchivable provides an interface for objects that can be put into message BArchivable provides an interface for objects that can be put into message
+2 -2
View File
@@ -14,7 +14,7 @@
/*! /*!
\file Archivable.h \file Archivable.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Contains BArchiver class. \brief Contains BArchiver class.
*/ */
@@ -22,7 +22,7 @@
/*! /*!
\class BArchiver \class BArchiver
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief A class that simplifies the archiving of complicated BArchivable \brief A class that simplifies the archiving of complicated BArchivable
hierarchies. hierarchies.
+2 -2
View File
@@ -13,7 +13,7 @@
/*! /*!
\file Autolock.h \file Autolock.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Implements a handy locking utility. \brief Implements a handy locking utility.
*/ */
@@ -21,7 +21,7 @@
/*! /*!
\class BAutolock \class BAutolock
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Convenient utility to make parts of your code thread-safe easily. \brief Convenient utility to make parts of your code thread-safe easily.
The autolocker uses a BLooper or a BLocker in order to protect a part The autolocker uses a BLooper or a BLocker in order to protect a part
+1 -1
View File
@@ -19,7 +19,7 @@
/*! /*!
\file Beep.h \file Beep.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Functions to generate sounds from the computer. \brief Functions to generate sounds from the computer.
*/ */
+2 -2
View File
@@ -18,7 +18,7 @@
/*! /*!
\file BlockCache.h \file BlockCache.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Implements a mechanism to store and retrieve memory blocks. \brief Implements a mechanism to store and retrieve memory blocks.
*/ */
@@ -40,7 +40,7 @@
/*! /*!
\class BBlockCache \class BBlockCache
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief A class that creates and maintains a pool of memory blocks. \brief A class that creates and maintains a pool of memory blocks.
In some performance critical code there might come a time where you require In some performance critical code there might come a time where you require
+2 -2
View File
@@ -15,7 +15,7 @@
/*! /*!
\file BufferIO.h \file BufferIO.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Provides the BBufferIO class. \brief Provides the BBufferIO class.
*/ */
@@ -23,7 +23,7 @@
/*! /*!
\class BBufferIO \class BBufferIO
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief A buffered adapter for BPositionIO objects. \brief A buffered adapter for BPositionIO objects.
This class differs from other classes derived from BPositionIO in a sense This class differs from other classes derived from BPositionIO in a sense
+2 -2
View File
@@ -15,7 +15,7 @@
/*! /*!
\file DataIO.h \file DataIO.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Defines abstract BDataIO and BPositionIO and the derived BMallocIO and BMemoryIO classes. \brief Defines abstract BDataIO and BPositionIO and the derived BMallocIO and BMemoryIO classes.
Pure virtual BDataIO and BPositioIO classes provide Pure virtual BDataIO and BPositioIO classes provide
@@ -32,7 +32,7 @@
/*! /*!
\class BDataIO \class BDataIO
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Abstract interface for objects that provide read and write access to \brief Abstract interface for objects that provide read and write access to
data. data.
+2 -2
View File
@@ -14,7 +14,7 @@
/*! /*!
\file Flattenable.h \file Flattenable.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Provides the BFlattenable interface \brief Provides the BFlattenable interface
*/ */
@@ -22,7 +22,7 @@
/*! /*!
\class BFlattenable \class BFlattenable
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Interface for classes that can flatten and unflatten themselves to \brief Interface for classes that can flatten and unflatten themselves to
a stream of bytes. a stream of bytes.
+2 -2
View File
@@ -19,7 +19,7 @@
/*! /*!
\file List.h \file List.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Defines the BList class. \brief Defines the BList class.
*/ */
@@ -27,7 +27,7 @@
/*! /*!
\class BList \class BList
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief An ordered container that is designed to hold generic \c void* \brief An ordered container that is designed to hold generic \c void*
objects. objects.
+2 -2
View File
@@ -13,7 +13,7 @@
/*! /*!
\file Locker.h \file Locker.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Provides locking class BLocker. \brief Provides locking class BLocker.
*/ */
@@ -21,7 +21,7 @@
/*! /*!
\class BLocker \class BLocker
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Semaphore-type class for thread safety. \brief Semaphore-type class for thread safety.
The BLocker interface is not merely a wrapper around a semaphore, but it The BLocker interface is not merely a wrapper around a semaphore, but it
+2 -2
View File
@@ -16,7 +16,7 @@
/*! /*!
\file String.h \file String.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Defines the BString class and global operators and functions for \brief Defines the BString class and global operators and functions for
handling strings. handling strings.
*/ */
@@ -24,7 +24,7 @@
/*! /*!
\class BString String.h \class BString String.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief String class supporting common string operations. \brief String class supporting common string operations.
BString is a string allocation and manipulation class. The object BString is a string allocation and manipulation class. The object
+1 -1
View File
@@ -13,7 +13,7 @@
/*! /*!
\file SupportDefs.h \file SupportDefs.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Defines basic types and definitions for the Haiku API. \brief Defines basic types and definitions for the Haiku API.
*/ */
+1 -1
View File
@@ -13,7 +13,7 @@
/*! /*!
\file TLS.h \file TLS.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Functions to use Thread Local Storage. \brief Functions to use Thread Local Storage.
The Thread Local Storage API provides convenient methods to transform global The Thread Local Storage API provides convenient methods to transform global
+2 -2
View File
@@ -14,7 +14,7 @@
/*! /*!
\file Archivable.h \file Archivable.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Contains BUnarchiver class used to simplify the unarchiving of \brief Contains BUnarchiver class used to simplify the unarchiving of
complicated BArchivable hierarchies. complicated BArchivable hierarchies.
*/ */
@@ -23,7 +23,7 @@
/*! /*!
\class BUnarchiver \class BUnarchiver
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief A class that simplifies the unarchiving of complicated BArchivable \brief A class that simplifies the unarchiving of complicated BArchivable
hierarchies. hierarchies.
+1 -1
View File
@@ -13,7 +13,7 @@
/*! /*!
\file parsedate.h \file parsedate.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Date parsing functions \brief Date parsing functions
This is a set a functions for parsing date strings in various formats. This is a set a functions for parsing date strings in various formats.
+2 -2
View File
@@ -14,7 +14,7 @@
/*! /*!
\file StopWatch.h \file StopWatch.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Provides the BStopWatch class. \brief Provides the BStopWatch class.
*/ */
@@ -22,7 +22,7 @@
/*! /*!
\class BStopWatch \class BStopWatch
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief A timer class. \brief A timer class.
This class provides method to time events. The interface is designed to This class provides method to time events. The interface is designed to
+1 -1
View File
@@ -14,7 +14,7 @@
/*! /*!
\file syslog.h \file syslog.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief System logging capabilities \brief System logging capabilities
The functions described here are interacting with the syslog_daemon, a server The functions described here are interacting with the syslog_daemon, a server
+1 -1
View File
@@ -13,7 +13,7 @@
/*! /*!
\file TypeConstants.h \file TypeConstants.h
\ingroup support \ingroup support
\ingroup libroot \ingroup libbe
\brief Represents typecodes that are used in various part of the Haiku API. \brief Represents typecodes that are used in various part of the Haiku API.
The type codes all refer to a specified type, except one. B_ANY_TYPE can The type codes all refer to a specified type, except one. B_ANY_TYPE can