Big docs cleanup.
* Fixed headers including: - All rights reserved not All Rights Reserved. - name, [email protected] not name <[email protected]> - tabs and spaces - Authors: not Documented by: * Renamed string.dox to String.dox * Renamed midixxx.dox files to MidiXxx.dox * Moved images into images subdirectories and updated Doxfile. * Re-format all files with tabs instead of spaces. * Fix many spelling mistakes. * Added all files, classes, structs, and enums to libbe group.
This commit is contained in:
@@ -1,17 +1,21 @@
|
||||
/*
|
||||
* Copyright 2010, Haiku, Inc. All Rights Reserved.
|
||||
* Copyright 2010 Haiku, Inc. All rights reserved.
|
||||
* Distributed under the terms of the MIT License.
|
||||
*
|
||||
* Documentation by:
|
||||
* Alex Wilson <[email protected]>
|
||||
* Authors:
|
||||
* Alex Wilson, [email protected]
|
||||
*
|
||||
* Corresponds to:
|
||||
* /trunk/headers/os/interface/GroupLayout.h rev 38207
|
||||
* /trunk/src/kits/interface/GroupLayout.cpp rev 38207
|
||||
* headers/os/interface/GroupLayout.h rev 38207
|
||||
* src/kits/interface/GroupLayout.cpp rev 38207
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\file GroupLayout.h
|
||||
\ingroup interface
|
||||
\ingroup layout
|
||||
\ingroup libbe
|
||||
\brief Describes the BGroupLayout class.
|
||||
*/
|
||||
|
||||
@@ -21,7 +25,7 @@
|
||||
\ingroup layout
|
||||
\ingroup libbe
|
||||
\brief The BGroupLayout class is a simple BLayout subclass that
|
||||
arranges the items it holds within a vertical or horizontal box.
|
||||
arranges the items it holds within a vertical or horizontal box.
|
||||
|
||||
In a horizontal BGroupLayout, each BLayoutItem is given the same vertical
|
||||
area, but different horizontal areas. In a vertical BGroupLayout, each
|
||||
@@ -47,7 +51,8 @@
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn BGroupLayout::BGroupLayout(enum orientation orientation, float spacing)
|
||||
/*!
|
||||
\fn BGroupLayout::BGroupLayout(enum orientation orientation, float spacing)
|
||||
\brief Creates a new BGroupLayout.
|
||||
|
||||
\param orientation The #orientation of this BGroupLayout.
|
||||
@@ -55,52 +60,61 @@
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn BGroupLayout::~BGroupLayout()
|
||||
/*!
|
||||
\fn BGroupLayout::~BGroupLayout()
|
||||
\brief Destructor method.
|
||||
|
||||
Standard Destructor.
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn BGroupLayout::BGroupLayout(BMessage* from)
|
||||
/*!
|
||||
\fn BGroupLayout::BGroupLayout(BMessage* from)
|
||||
\brief Archive constructor.
|
||||
|
||||
\param from The message to construct the BGroupLayout from.
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn float BGroupLayout::Spacing() const
|
||||
/*!
|
||||
\fn float BGroupLayout::Spacing() const
|
||||
\brief Get the amount of spacing (in pixels) between each item.
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn void BGroupLayout::SetSpacing(float spacing)
|
||||
/*!
|
||||
\fn void BGroupLayout::SetSpacing(float spacing)
|
||||
\brief Set the amount of spacing (in pixels) between each item.
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn orientation BGroupLayout::Orientation() const
|
||||
/*!
|
||||
\fn orientation BGroupLayout::Orientation() const
|
||||
\brief Get the #orientation of this BGroupLayout.
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn void BGroupLayout::SetOrientation(enum orientation orientation)
|
||||
/*!
|
||||
\fn void BGroupLayout::SetOrientation(enum orientation orientation)
|
||||
\brief Set the #orientation of this BGroupLayout.
|
||||
\param orientation The new #orientation of this BGroupLayout.
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn float BGroupLayout::ItemWeight(int32 index) const
|
||||
/*!
|
||||
\fn float BGroupLayout::ItemWeight(int32 index) const
|
||||
\brief Get the weight of the item at \a index.
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn void BGroupLayout::SetItemWeight(int32 index, float weight)
|
||||
/*!
|
||||
\fn void BGroupLayout::SetItemWeight(int32 index, float weight)
|
||||
\brief Set the weight of the item at \a index.
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn BLayoutItem* BGroupLayout::AddView(BView* child)
|
||||
/*!
|
||||
\fn BLayoutItem* BGroupLayout::AddView(BView* child)
|
||||
\brief Adds \a child to this layout as the last item. In a vertical
|
||||
BGroupLayout, \a child will be on the right, in a horizontal
|
||||
BGroupLayout, \a child will be at the bottom.
|
||||
@@ -109,27 +123,31 @@
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn BLayoutItem* BGroupLayout::AddView(int32 index, BView* child)
|
||||
/*!
|
||||
\fn BLayoutItem* BGroupLayout::AddView(int32 index, BView* child)
|
||||
\brief Adds \a child to this layout at \a index.
|
||||
|
||||
\a child will have a weight of \c 1.0f.
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn BLayoutItem* BGroupLayout::AddView(BView* child, float weight)
|
||||
/*!
|
||||
\fn BLayoutItem* BGroupLayout::AddView(BView* child, float weight)
|
||||
\brief Adds \a child to the end of this layout with a weight of
|
||||
\a weight.
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn BLayoutItem* BGroupLayout::AddView(int32 index, BView* child,
|
||||
/*!
|
||||
\fn BLayoutItem* BGroupLayout::AddView(int32 index, BView* child,
|
||||
float weight)
|
||||
\brief Adds \a child this layout at \a index with a weight of
|
||||
\a weight.
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn bool BGroupLayout::AddItem(BLayoutItem* item)
|
||||
/*!
|
||||
\fn bool BGroupLayout::AddItem(BLayoutItem* item)
|
||||
\brief Adds \a item to this layout as the last item. In a vertical
|
||||
BGroupLayout, \a item will be on the right, in a horizontal
|
||||
BGroupLayout, \a item will be at the bottom.
|
||||
@@ -138,20 +156,23 @@
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn bool BGroupLayout::AddItem(int32 index, BLayoutItem* item)
|
||||
/*!
|
||||
\fn bool BGroupLayout::AddItem(int32 index, BLayoutItem* item)
|
||||
\brief Adds \a item to this layout at \a index.
|
||||
|
||||
\a item will have a weight of \c 1.0f.
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn bool BGroupLayout::AddItem(BLayoutItem* item, float weight)
|
||||
/*!
|
||||
\fn bool BGroupLayout::AddItem(BLayoutItem* item, float weight)
|
||||
\brief Adds \a item to the end of this layout with a weight of
|
||||
\a weight.
|
||||
*/
|
||||
|
||||
|
||||
/*! \fn bool BGroupLayout::AddItem(int32 index, BLayoutItem* item, float weight)
|
||||
/*!
|
||||
\fn bool BGroupLayout::AddItem(int32 index, BLayoutItem* item, float weight)
|
||||
\brief Adds \a item this layout at \a index with a weight of
|
||||
\a weight.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user