From d579eb9efe82919385bd0e18d9c26baa6d5d46bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1ximo=20Casta=C3=B1eda?= Date: Sun, 28 Jan 2024 17:28:15 +0100 Subject: [PATCH] HaikuBook: minor fixes Fix some copy-pasta and strange grammar. Remove a note that seems unnecessary in context and easy to misinterpret out of context. Change-Id: If1ce26b293c8098c260a9697fb0ef0611a4958c4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/7358 Reviewed-by: Adrien Destugues Tested-by: Commit checker robot --- docs/user/interface/Dragger.dox | 2 +- docs/user/interface/ListView.dox | 4 ++-- docs/user/interface/OutlineListView.dox | 24 ++++++++++-------------- docs/user/interface/View.dox | 4 ++-- 4 files changed, 15 insertions(+), 19 deletions(-) diff --git a/docs/user/interface/Dragger.dox b/docs/user/interface/Dragger.dox index 6b303667d9..24f650db1f 100644 --- a/docs/user/interface/Dragger.dox +++ b/docs/user/interface/Dragger.dox @@ -167,7 +167,7 @@ This results in the archiving of the target view and the dragger and initiates a drag-and-drop operation. - \param point The point on the screen where to mouse pointer is when + \param point The point on the screen where the mouse pointer is when the mouse is clicked. \since BeOS R3 diff --git a/docs/user/interface/ListView.dox b/docs/user/interface/ListView.dox index 582b7eb581..1cce11c786 100644 --- a/docs/user/interface/ListView.dox +++ b/docs/user/interface/ListView.dox @@ -752,7 +752,7 @@ \fn BListItem* BListView::FirstItem() const \brief Returns a pointer to the first list item. - \return A pointer to the first item in the list or \c NULL there are no items. + \return A pointer to the first item in the list or \c NULL if there are no items. \since BeOS R3 */ @@ -762,7 +762,7 @@ \fn BListItem* BListView::LastItem() const \brief Returns a pointer to the last list item. - \return A pointer to the last item in the list or \c NULL there are no items. + \return A pointer to the last item in the list or \c NULL if there are no items. \since BeOS R3 */ diff --git a/docs/user/interface/OutlineListView.dox b/docs/user/interface/OutlineListView.dox index 0fbaef30b6..5033527415 100644 --- a/docs/user/interface/OutlineListView.dox +++ b/docs/user/interface/OutlineListView.dox @@ -207,7 +207,7 @@ Responds to mouse clicks expanding or collapsing sections of the outline when the user clicks on a latch. - \param where The point on the screen where to mouse pointer is when + \param where The point on the screen where the mouse pointer is when the mouse button is pressed. \see BListView::MouseDown() @@ -280,7 +280,7 @@ \param newItems The list of items to add. - \return \c true if the items was added, \c false otherwise. + \return \c true if the items were added, \c false otherwise. \since BeOS R3 */ @@ -291,9 +291,9 @@ \brief Adds a list of items at \a fullListIndex \param newItems The list of items to add. - \param fullListIndex The index to add \a item at. + \param fullListIndex The index at which to start adding the items. - \return \c true if the items was added, \c false otherwise. + \return \c true if the items were added, \c false otherwise. \since BeOS R3 */ @@ -337,8 +337,8 @@ /*! \name Full List - These methods replicate similar methods in BListView except work on the - full list. + These methods replicate similar methods in BListView, but they work on the + full list, without discarding collapsed items. */ @@ -374,7 +374,7 @@ \fn int32 BOutlineListView::FullListIndexOf(BListItem* item) const \brief Returns the full list index of \a item. - \return The index of the item at \a where or -1 if not found. + \return The index of \a item or -1 if not found. \see BListView::IndexOf(BPoint point) @@ -386,7 +386,7 @@ \fn BListItem* BOutlineListView::FullListFirstItem() const \brief Returns a pointer to the first BListItem in the list. - \return A pointer to the first item in the list or \c NULL there are no + \return A pointer to the first item in the list or \c NULL if there are no items. \see BListView::FirstItem() @@ -399,7 +399,7 @@ \fn BListItem* BOutlineListView::FullListLastItem() const \brief Returns a pointer to the list BListItem in the list - \return A pointer to the last item in the list or \c NULL there are no + \return A pointer to the last item in the list or \c NULL if there are no items. \see BListView::LastItem() @@ -547,7 +547,7 @@ /*! \fn void BOutlineListView::FullListSortItems( int (*compareFunc)(const BListItem* a, const BListItem* b)) - \brief Sort the items according the the passed in compare function. + \brief Sorts the items according to the passed in compare function. \param compareFunc The compare function to use to sort the items. @@ -611,10 +611,6 @@ bool oneLevelOnly, int32 index) const \brief Returns a pointer to the item at \a index under \a superItem. - \note If \a oneLevelOnly is \a false, this method acts like - FullListItemAt() except the first item in the list is - considered to be \a superItem. - \param superItem The base item. \param oneLevelOnly if \c true, only items located one level under superItem are considered. diff --git a/docs/user/interface/View.dox b/docs/user/interface/View.dox index 76b7a6d082..b43cbabc67 100644 --- a/docs/user/interface/View.dox +++ b/docs/user/interface/View.dox @@ -1042,7 +1042,7 @@ SetViewColor(Parent()->ViewColor()); \fn void BView::MouseDown(BPoint where) \brief Hook method called when a mouse button is pressed. - \param where The point on the screen where to mouse pointer is when + \param where The point on the screen where the mouse pointer is when the mouse button is pressed. \since BeOS R3 @@ -1053,7 +1053,7 @@ SetViewColor(Parent()->ViewColor()); \fn void BView::MouseUp(BPoint where) \brief Hook method called when a mouse button is released. - \param where The point on the screen where to mouse pointer is when + \param where The point on the screen where the mouse pointer is when the mouse button is released. \note Calling GetMouse() in MouseUp() will return the new state of the mouse buttons