[haiku-commits] haiku: hrev45054 - in docs/user: interface storage

  • From: jscipione@xxxxxxxxx
  • To: haiku-commits@xxxxxxxxxxxxx
  • Date: Sat, 22 Dec 2012 04:51:49 +0100 (CET)

hrev45054 adds 3 changesets to branch 'master'
old head: b510524436d85a3970e610ca7ed68638652f1830
new head: 268177055e889e53b8fdf80ed7a33f484662f8c7
overview: http://cgit.haiku-os.org/haiku/log/?qt=range&q=2681770+%5Eb510524

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

177942a: Remove documentation fro Button.dox that is not unique to BButton 
fixing a few warnings

f729cb8: Remove methods from CheckBox.dox that are not unique to the class 
fixing warnings

2681770: Fix 2 warnings in MimeType.dox

                                     [ John Scipione <jscipione@xxxxxxxxx> ]

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

3 files changed, 2 insertions(+), 216 deletions(-)
docs/user/interface/Button.dox   | 123 -----------------------------------
docs/user/interface/CheckBox.dox |  90 -------------------------
docs/user/storage/MimeType.dox   |   5 +-

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

Commit:      177942adc7ca79d157772aec2c401b76b8ce2758
URL:         http://cgit.haiku-os.org/haiku/commit/?id=177942a
Author:      John Scipione <jscipione@xxxxxxxxx>
Date:        Sat Dec 22 03:42:46 2012 UTC

Remove documentation fro Button.dox that is not unique to BButton fixing a few 
warnings

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

diff --git a/docs/user/interface/Button.dox b/docs/user/interface/Button.dox
index 6bcd7d7..9932b70 100644
--- a/docs/user/interface/Button.dox
+++ b/docs/user/interface/Button.dox
@@ -170,36 +170,6 @@
 
 
 /*!
-       \fn void BButton::MouseDown(BPoint point)
-       \brief Hook method that is called when a mouse button is pressed.
-
-       \param point The point on the screen where to mouse pointer is when
-               the mouse button is pressed.
-
-       \sa BView::MouseDown()
-*/
-
-
-/*!
-       \fn void BButton::AttachedToWindow()
-       \brief Hook method that is called when the object is attached to a
-               window.
-
-       \sa BControl::AttachedToWindow()
-*/
-
-
-/*!
-       \fn void BButton::KeyDown(const char *bytes, int32 numBytes)
-       \brief Hook method that is called when a keyboard key is pushed down.
-               to the window.
-       
-       \param bytes The key pressed.
-       \param numBytes The number of keys pressed.
-*/
-
-
-/*!
        \fn void BButton::MakeDefault(bool flag)
        \brief Make the BButton the default button i.e. it will be activated
                when the user pushes the \key{Enter} key.
@@ -259,14 +229,6 @@
 
 
 /*!
-       \fn void BButton::ResizeToPreferred()
-       \brief Resizes the BButton to its preferred size.
-
-       \see BView::ResizeToPreferred()
-*/
-
-
-/*!
        \fn status_t BButton::Invoke(BMessage *message)
        \brief The BButton is invoked from a message.
 
@@ -282,88 +244,3 @@
 
        \see BControl::Invoke()
 */
-
-
-/*!
-       \fn void BButton::FrameMoved(BPoint newLocation)
-       \brief Hook method that is called when the BButton has moved.
-
-       \param newLocation The location on the screen that the BButton
-               is moved to.
-
-       \see BView::FrameMoved();
-*/
-
-
-/*!
-       \fn void BButton::FrameResized(float width, float height)
-       \brief Hook method that is called when the BButton changes size.
-
-       \param width the new \a width of the BButton
-       \param height the new \a height of the BButton
-
-       \see BView::FrameResized();
-*/
-
-
-/*!
-       \fn void BButton::MakeFocus(bool focused)
-       \brief Focus or unfocus the BButton.
-
-       \param focused If \c true focus the button, otherwise remove focus from
-               the button.
-
-       \see BControl::MakeFocus()
-*/
-
-
-/*!
-       \fn status_t BButton::Perform(perform_code code, void* _data)
-       \brief Perform an action on the BButton.
-
-       \param code The \a perform_code. One of the following:
-               \li \c PERFORM_CODE_MIN_SIZE
-               \li \c PERFORM_CODE_MAX_SIZE
-               \li \c PERFORM_CODE_PREFERRED_SIZE
-               \li \c PERFORM_CODE_LAYOUT_ALIGNMENT
-               \li \c PERFORM_CODE_HAS_HEIGHT_FOR_WIDTH
-               \li \c PERFORM_CODE_GET_HEIGHT_FOR_WIDTH
-               \li \c PERFORM_CODE_SET_LAYOUT
-               \li \c PERFORM_CODE_INVALIDATE_LAYOUT
-               \li \c PERFORM_CODE_DO_LAYOUT
-       \param _data Data to use to act on.
-
-       \returns \c B_OK if the action was successful or an error code if not.
-*/
-
-
-/*!
-       \fn void BButton::InvalidateLayout(bool descendants)
-       \brief Redraws the BButton.
-
-       \param descendants Redraw subviews as well.
-*/
-
-
-/*!
-       \fn BSize BButton::MinSize()
-       \brief Returns the minimum size of the BButton.
-
-       \returns The minimum BButton size as a BSize
-*/
-
-
-/*!
-       \fn BSize BButton::MaxSize()
-       \brief Returns the maximum size of the BButton.
-
-       \returns The maximum BButton size as a BSize
-*/
-
-
-/*!
-       \fn BSize BButton::PreferredSize()
-       \brief Returns the preferred size of the BButton.
-
-       \returns The preferred BButton size as a BSize
-*/

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

Commit:      f729cb8d48f788cbf076a49e9e4a5f973ac378a4
URL:         http://cgit.haiku-os.org/haiku/commit/?id=f729cb8
Author:      John Scipione <jscipione@xxxxxxxxx>
Date:        Sat Dec 22 03:46:57 2012 UTC

Remove methods from CheckBox.dox that are not unique to the class fixing 
warnings

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

diff --git a/docs/user/interface/CheckBox.dox b/docs/user/interface/CheckBox.dox
index 917a272..95c5607 100644
--- a/docs/user/interface/CheckBox.dox
+++ b/docs/user/interface/CheckBox.dox
@@ -127,28 +127,6 @@
 
 
 /*!
-       \fn void BCheckBox::FrameMoved(BPoint newLocation)
-       \brief Hook method that gets called when the checkbox is moved.
-
-       \param newLocation The point that the top left corner of the frame
-               is moved to.
-
-       \sa BView::FrameMoved()
-*/
-
-
-/*!
-       \fn void BCheckBox::FrameResized(float width, float height)
-       \brief Hook method that gets called when the checkbox is resized.
-
-       \param width The new \a width of the checkbox.
-       \param height The new \a height of the checkbox.
-
-       \sa BView::FrameResized()
-*/
-
-
-/*!
        \fn void BCheckBox::GetPreferredSize(float* _width, float* _height)
        \brief Fill out the preferred width and height of the checkbox
                into the \a _width and \a _height parameters.
@@ -161,64 +139,6 @@
 
 
 /*!
-       \fn void BCheckBox::ResizeToPreferred()
-       \brief Resize the checkbox to its preferred size.
-
-       \sa BView::ResizeToPreferred()
-*/
-
-
-/*!
-       \fn void BCheckBox::InvalidateLayout(bool descendants)
-       \brief \brief Redraws the checkbox.
-
-       \param descendants Redraw child views as well.
-
-       \sa BLayout::InvalidateLayout()
-*/
-
-
-/*!
-       \fn BSize BCheckBox::MinSize()
-       \brief Get the minimum size of the checkbox.
-
-       \return The minimum size of the checkbox as a BSize.
-
-       \sa BAbstractLayout::MinSize()
-*/
-
-
-/*!
-       \fn BSize BCheckBox::MaxSize()
-       \brief Get the maximum size of the checkbox.
-
-       \return The maximum size of the checkbox as a BSize.
-
-       \sa BAbstractLayout::MaxSize()
-*/
-
-
-/*!
-       \fn BSize BCheckBox::PreferredSize()
-       \brief Get the preferred size of the checkbox.
-
-       \return The preferred size of the checkbox as a BSize.
-
-       \sa BAbstractLayout::PreferredSize()
-*/
-
-
-/*!
-       \fn void BCheckBox::MakeFocus(bool focused)
-       \brief Gives or removes focus from the checkbox.
-
-       \param focused \a true to set focus, \a false to remove it.
-
-       \sa BControl::MakeFocus()
-*/
-
-
-/*!
        \fn void BCheckBox::SetValue(int32 value)
        \brief Turn the checkbox on or off.
 
@@ -227,13 +147,3 @@
 
        \sa BControl::SetValue()
 */
-
-
-/*!
-       \fn status_t BCheckBox::Invoke(BMessage *message)
-       \brief Tells the messenger to send a message.
-
-       \param message The \a message to send.
-
-       \sa BInvoker::Invoke()
-*/

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

Revision:    hrev45054
Commit:      268177055e889e53b8fdf80ed7a33f484662f8c7
URL:         http://cgit.haiku-os.org/haiku/commit/?id=2681770
Author:      John Scipione <jscipione@xxxxxxxxx>
Date:        Sat Dec 22 03:50:52 2012 UTC

Fix 2 warnings in MimeType.dox

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

diff --git a/docs/user/storage/MimeType.dox b/docs/user/storage/MimeType.dox
index 7413045..ce32e73 100644
--- a/docs/user/storage/MimeType.dox
+++ b/docs/user/storage/MimeType.dox
@@ -361,7 +361,7 @@
 
 
 /*!
-       \fn status_tBMimeType::GetFileExtensions(BMessage *extensions) const
+       \fn status_t BMimeType::GetFileExtensions(BMessage *extensions) const
        \brief Fetches the MIME type's associated filename extensions from the
                MIME database.
 
@@ -525,9 +525,8 @@
 */
 
 
-// 
 /*!
-       \fn status_t BMimeType::SetP0referredApp(const char *signature,
+       \fn status_t BMimeType::SetPreferredApp(const char *signature,
                app_verb verb)
        \brief Sets the preferred application for the MIME type.
 


Other related posts:

  • » [haiku-commits] haiku: hrev45054 - in docs/user: interface storage - jscipione