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:
John Scipione
2013-02-07 02:01:19 -05:00
parent 8cf4ba89b6
commit 820dca4df6
109 changed files with 6698 additions and 5170 deletions
+14 -10
View File
@@ -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/Layout.h rev 38207
* /trunk/src/kits/interface/Layout.cpp rev 38207
* headers/os/interface/Layout.h rev 38207
* src/kits/interface/Layout.cpp rev 38207
*/
/*!
\file Layout.h
\ingroup interface
\ingroup layout
\ingroup libbe
\brief Defines the BLayout class.
*/
@@ -72,7 +76,7 @@ topLayout->AddItem(nestedLayoutWithView);
After this constructor has finished, this BLayout holds no
BLayoutItem&apos;s and does not have a target BView.
\warning Because a new BLayout does not have a target BView, calls to the
AddItem() and AddView() will fail methods will fail.
*/
@@ -147,7 +151,7 @@ topLayout->AddItem(nestedLayoutWithView);
this layout.
\a child is added to this BLayout&apos;s target view.
\returns The BLayoutItem created to represent \a child is, or \c NULL if
there was an error.
@@ -208,7 +212,7 @@ topLayout->AddItem(nestedLayoutWithView);
it represents from this BLayout&apos;s target view.
\param item The BLayoutItem to be removed
\warning \a item is not deleted, you must delete it manually, or add it to
another BLayout.
\warning \a item->View(), even when it is removed from the target view,
@@ -255,7 +259,7 @@ topLayout->AddItem(nestedLayoutWithView);
/*!
\fn int32 BLayout::IndexOfView(BView* child) const
\brief Get the index of \a child in this layout.
\note This finds the index of views added through BLayout::AddView(), not
the index of an item which represents \a child that was added through
BLayout::AddItem().
@@ -339,7 +343,7 @@ topLayout->AddItem(nestedLayoutWithView);
\brief If there is no layout currently ongoing, and \a force is \c false,
creates a new BLayoutContext and calls the DoLayout() method
of this BLayout and any BLayout s nested in this BLayout.
This method also guarantees that the owner view of this layout (as returned
by BLayout::Owner()) performs a layout as well (if it is suitable to do so).