From 44b874666af6b25da6311e5a1c506ee3761f4268 Mon Sep 17 00:00:00 2001 From: John Scipione Date: Thu, 9 Nov 2017 13:14:19 -0800 Subject: [PATCH] API docs: it's => its fix --- docs/user/app/Cursor.dox | 2 +- docs/user/app/Invoker.dox | 2 +- docs/user/drivers/USB3.dox | 2 +- docs/user/drivers/usb_modules.dox | 4 ++-- docs/user/interface/CheckBox.dox | 2 +- docs/user/interface/Font.dox | 6 +++--- docs/user/interface/IconUtils.dox | 4 ++-- docs/user/interface/Layout.dox | 2 +- docs/user/interface/ListView.dox | 2 +- docs/user/interface/MenuBar.dox | 2 +- docs/user/interface/MenuField.dox | 2 +- docs/user/interface/Picture.dox | 2 +- docs/user/interface/RadioButton.dox | 2 +- docs/user/interface/View.dox | 22 +++++++++++----------- docs/user/interface/Window.dox | 6 +++--- docs/user/shared/json.dox | 2 +- docs/user/support/Locker.dox | 4 ++-- 17 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/user/app/Cursor.dox b/docs/user/app/Cursor.dox index aa655d3617..46c961d50b 100644 --- a/docs/user/app/Cursor.dox +++ b/docs/user/app/Cursor.dox @@ -317,7 +317,7 @@ /*! \fn BCursor::~BCursor() - \brief Destroy the cursor and free it's memory. + \brief Destroy the cursor and free its memory. \since BeOS R5 */ diff --git a/docs/user/app/Invoker.dox b/docs/user/app/Invoker.dox index 8c85fd18c9..6450be84b5 100644 --- a/docs/user/app/Invoker.dox +++ b/docs/user/app/Invoker.dox @@ -280,7 +280,7 @@ was called. If you care whether Invoke() or InvokeNotify() was originally called, - you can use a bool pointer and set it's value to \c true if InvokeNotify() + you can use a bool pointer and set its value to \c true if InvokeNotify() was called, or \c false if Invoke() was called. This lets you fetch the InvokeNotify() arguments from Invoke() without breaking binary compatibility with older applications. diff --git a/docs/user/drivers/USB3.dox b/docs/user/drivers/USB3.dox index 9df6323588..2e091e7b0c 100644 --- a/docs/user/drivers/USB3.dox +++ b/docs/user/drivers/USB3.dox @@ -605,7 +605,7 @@ \brief Convenience function for standard usb status requests. \param[in] handle The object you want to query. - \param[out] status A variable in which the device can store it's status. + \param[out] status A variable in which the device can store its status. \return \c B_OK is returned in case the request succeeded and the device responded positively, or an error code is returned in case it failed. */ diff --git a/docs/user/drivers/usb_modules.dox b/docs/user/drivers/usb_modules.dox index b75cdb92ec..9a99df015f 100644 --- a/docs/user/drivers/usb_modules.dox +++ b/docs/user/drivers/usb_modules.dox @@ -31,7 +31,7 @@ the host controller and the devices, and how devices should transfer data, but it does not prescribe a standard environment that Operating Systems should provide to the driver interfaces. As such, every operating system has - it's own interface for drivers, and so does Haiku. + its own interface for drivers, and so does Haiku. This document will point driver developers to relevant parts of the USB module API and give a general impression of the workings of the USB stack. @@ -135,7 +135,7 @@ init_driver(void) to provide the stack with information on which devices you support, and the number of support descriptors you provided. The stack is very flexible with what patterns it accepts, so even the most complex driver will be able to - pass it's credentials. Have a look at the \c usb_support_descriptor struct + pass its credentials. Have a look at the \c usb_support_descriptor struct and the \c usb_module_info::register_driver() call for all the details. The last step in initialization is to provide the stack with notification diff --git a/docs/user/interface/CheckBox.dox b/docs/user/interface/CheckBox.dox index 73fb1ac448..029a10f891 100644 --- a/docs/user/interface/CheckBox.dox +++ b/docs/user/interface/CheckBox.dox @@ -53,7 +53,7 @@ \brief Construct a check box in the \a frame with a \a name, \a label, model \a message, \a resizingMode, and creation \a flags. - \note This constructor will resize the control to it's minimum height if needed + \note This constructor will resize the control to its minimum height if needed for compatibility with BeOS R5. The initial value of the check box is 0 (\c B_CONTROL_OFF). diff --git a/docs/user/interface/Font.dox b/docs/user/interface/Font.dox index 9410e9752e..6ed9d3f150 100644 --- a/docs/user/interface/Font.dox +++ b/docs/user/interface/Font.dox @@ -867,7 +867,7 @@ \class BFont \ingroup interface \ingroup libbe - \brief Represents a typeface including it's family, style and size. + \brief Represents a typeface including its family, style and size. The Interface Kit provides three prebuilt BFont objects which can be used but not modified. @@ -875,7 +875,7 @@ - \c const BFont* \c be_bold_font A bold font used by titles. - \c const BFont* \c be_fixed_font A fixed-width font. - A BFont object does nothing on it's own but is used in combination with + A BFont object does nothing on its own but is used in combination with a view or control. Here is an example of creating a BFont object from a system font and assigning it to a view: @@ -1054,7 +1054,7 @@ - \c B_CHAR_SPACING Position each character without adjustment. Best mode for printing. Characters may collide or overlap at small font sizes. - - \c B_STRING_SPACING Optimizes the position of each character within it's + - \c B_STRING_SPACING Optimizes the position of each character within its space. Collisions are unlikely but characters may touch each other. Best mode to use when the screen needs to match what appears on the printed page. Adding new characters requires the entire string to diff --git a/docs/user/interface/IconUtils.dox b/docs/user/interface/IconUtils.dox index fef6ac3c46..2d4a4e4ccd 100644 --- a/docs/user/interface/IconUtils.dox +++ b/docs/user/interface/IconUtils.dox @@ -68,7 +68,7 @@ format from a BNode attribute into the preallocated BBitmap \a result. The colorspace of result needs to be B_RGBA32 or at least B_RGB32 (though that makes less sense). The icon - will be scaled from it's "native" size of 64x64 to the + will be scaled from its "native" size of 64x64 to the size of the bitmap. \note The scale is derived from the bitmap width, the bitmap should have @@ -88,7 +88,7 @@ format from the given \a buffer into the preallocated BBitmap \a result. The colorspace of result needs to be B_RGBA32 or at least B_RGB32 (though that makes less sense). The icon - will be scaled from it's "native" size of 64x64 to the + will be scaled from its "native" size of 64x64 to the size of the bitmap. \note The scale is derived from the bitmap width, the bitmap should have diff --git a/docs/user/interface/Layout.dox b/docs/user/interface/Layout.dox index fc73d8801e..ce52e19cc1 100644 --- a/docs/user/interface/Layout.dox +++ b/docs/user/interface/Layout.dox @@ -34,7 +34,7 @@ view. When a BLayout is attached directly to a BView via BView::SetLayout() then that BView becomes the target of the layout. When a BLayout is nested in another BLayout (via BLayout::AddItem()) the nested BLayout inherits the - target of the layout it's nested in, if it does not have a target already. + target of the layout its nested in, if it does not have a target already. You can retrieve the target view for a layout with the TargetView() method. When adding a BLayoutItem to a BLayout, the item's view (as returned by BLayoutItem::View()) is added to the BLayout's target view. diff --git a/docs/user/interface/ListView.dox b/docs/user/interface/ListView.dox index 6d9090a52f..aadb688efd 100644 --- a/docs/user/interface/ListView.dox +++ b/docs/user/interface/ListView.dox @@ -373,7 +373,7 @@ /*! \fn void BListView::ResizeToPreferred() - \brief Resize the view to it's preferred size. + \brief Resize the view to its preferred size. \see BView::ResizeToPreferred() diff --git a/docs/user/interface/MenuBar.dox b/docs/user/interface/MenuBar.dox index 803384f612..54c5e9de9c 100644 --- a/docs/user/interface/MenuBar.dox +++ b/docs/user/interface/MenuBar.dox @@ -75,7 +75,7 @@ BWindow::SetKeyMenuBar() method. When either the \key{Menu} key or \key{Command}+\key{Esc} keys are pressed - the key menu bar opens and focuses it's first menu item, typically a BMenu. + the key menu bar opens and focuses its first menu item, typically a BMenu. Once the menu bar is open the user can navigate around the attached menus and menu items using the arrow keys. diff --git a/docs/user/interface/MenuField.dox b/docs/user/interface/MenuField.dox index 3bbc484ad8..46272263b6 100644 --- a/docs/user/interface/MenuField.dox +++ b/docs/user/interface/MenuField.dox @@ -36,7 +36,7 @@ by the bounds set by the divider position and \a frame rectangle. A variable-size menu field's menu bar is only as wide as it needs to - be in order to fit the currently selected menu item, and it's height + be in order to fit the currently selected menu item, and its height depends on the user's menu font size preference. The height of the frame rectangle is ignored. diff --git a/docs/user/interface/Picture.dox b/docs/user/interface/Picture.dox index 9162bc545c..2a7fa5910c 100644 --- a/docs/user/interface/Picture.dox +++ b/docs/user/interface/Picture.dox @@ -43,7 +43,7 @@ picture = view->EndPicture(); \endcode - Only drawing instructions performed directly on the view, not it's child + Only drawing instructions performed directly on the view, not its child views are send to the BPicture object and BPicture captures only primitive graphics operations. The view must be attached to a window for the drawing instruction to be recorded. Drawing instructions are recorded even if the diff --git a/docs/user/interface/RadioButton.dox b/docs/user/interface/RadioButton.dox index 51a5e0d0ae..b02c7826b0 100644 --- a/docs/user/interface/RadioButton.dox +++ b/docs/user/interface/RadioButton.dox @@ -52,7 +52,7 @@ \brief Construct a radio button in the \a frame rectangle with a \a name, \a label, model \a message, \a resizingMode, and creation \a flags. - \note This constructor will resize the control to it's minimum height if needed + \note This constructor will resize the control to its minimum height if needed for compatibility with BeOS R5. The initial value of the radio button is 0 (\c B_CONTROL_OFF). diff --git a/docs/user/interface/View.dox b/docs/user/interface/View.dox index 6ae10e7545..98bade3b65 100644 --- a/docs/user/interface/View.dox +++ b/docs/user/interface/View.dox @@ -266,7 +266,7 @@ /*! \var B_WILL_DRAW - \brief Indicates that the view will do it's own drawing. + \brief Indicates that the view will do its own drawing. \since BeOS R3 */ @@ -548,7 +548,7 @@ To create a subclass of BView you generally override one or more of BView's hook methods to respond to user events such as MouseDown() or FrameMoved(). - By default a BView does nothing in it's hook methods unless otherwise stated, + By default a BView does nothing in its hook methods unless otherwise stated, it's up to you to define what happens. To override the look of a BView you should override the Draw() or DrawAfterChildren() methods. See the section on Hook Methods below for more details. @@ -589,9 +589,9 @@ if (Window()->LockLooper()) { focus view. The color can be queried using the keyboard_navigation_color() function in InterfaceDefs.h - Each view has it's own coordinate system with the origin point (0.0, 0.0) + Each view has its own coordinate system with the origin point (0.0, 0.0) located at the top left corner. You can convert a BPoint or BRect to or from - the view's coordinate system to the coordinate system of it's parent, or + the view's coordinate system to the coordinate system of its parent, or of the screen's coordinate system. See the section on Coordinate Conversion Methods for more details. @@ -639,7 +639,7 @@ SetViewColor(Parent()->ViewColor()); \param name The name of the view, can be \c NULL. \param flags The view flags, a mask of one or more of the following: - \c B_FULL_UPDATE_ON_RESIZE Redraw the entire view on resize. - - \c B_WILL_DRAW Indicates that the view will do it's own drawing. + - \c B_WILL_DRAW Indicates that the view will do its own drawing. - \c B_PULSE_NEEDED The view accepts Pulse() messages. - \c B_NAVIGABLE_JUMP Default for keyboard navigation. - \c B_FRAME_EVENTS Responds to move and resize events. @@ -704,7 +704,7 @@ SetViewColor(Parent()->ViewColor()); \c B_FOLLOW_LEFT_RIGHT | \c B_FOLLOW_TOP_BOTTOM. \param flags The view flags, a mask of one or more of the following: - \c B_FULL_UPDATE_ON_RESIZE Redraw the entire view on resize. - - \c B_WILL_DRAW Indicates that the view will do it's own drawing. + - \c B_WILL_DRAW Indicates that the view will do its own drawing. - \c B_PULSE_NEEDED The view accepts Pulse() messages. - \c B_NAVIGABLE_JUMP Default for keyboard navigation. - \c B_FRAME_EVENTS Responds to move and resize events. @@ -1313,8 +1313,8 @@ SetViewColor(Parent()->ViewColor()); \brief Returns whether or not the view is hidden from the perspective of \a lookingFrom. - A view is considered hidden if it, any of it's parent views, or the window - it is attached to has had the Hide() method called on it. This method + A view is considered hidden if it, any of its parent views, or the window + it's attached to has had the Hide() method called on it. This method allows you to determine the hidden status of a view from a different point on the view hierarchy. @@ -2564,9 +2564,9 @@ SetViewColor(Parent()->ViewColor()); DrawString() The \a string is drawn in the view's current font and is modified by - the other parameters of the font such as it's direction (left-to-right or + the other parameters of the font such as its direction (left-to-right or right-to-left), rotation, spacing, shear, etc. The \a string is always drawn - left to right even if it's text direction is set to right-to-left mode. + left to right even if its text direction is set to right-to-left mode. Drawing a string is fastest in \c B_OP_COPY mode and anti-aliasing can produce undesirable effects when a string is draw in other modes, especially @@ -3580,7 +3580,7 @@ SetViewColor(Parent()->ViewColor()); The view doesn't display anything to the screen while it's recording to \a picture. Use the DrawPicture() method to render the \a picture. - Only drawing instructions performed directly on the view, not it's child views + Only drawing instructions performed directly on the view, not its child views are send to the BPicture object and BPicture captures only primitive graphics operations. The view must be attached to a window for the drawing instruction to be recorded. Drawing instructions are recorded even if the view is hidden or diff --git a/docs/user/interface/Window.dox b/docs/user/interface/Window.dox index 4d7653bfbc..89f0960706 100644 --- a/docs/user/interface/Window.dox +++ b/docs/user/interface/Window.dox @@ -368,7 +368,7 @@ /*! \var B_OUTLINE_RESIZE - Window draws only it's outline as it's resized and doesn't draw its + Window draws only its outline as it's resized and doesn't draw its contents. \since BeOS R3 @@ -624,7 +624,7 @@ - \c B_AVOID_FOCUS cannot receive keyboard focus - \c B_WILL_ACCEPT_FIRST_CLICK The first click is processed by the window. - - \c B_OUTLINE_RESIZE draws only it's outline as it's resized and + - \c B_OUTLINE_RESIZE draws only its outline as it's resized and doesn't draw its contents. - \c B_NO_WORKSPACE_ACTIVATION Causes the current workspace to stay active when activated on another workspace. @@ -696,7 +696,7 @@ - \c B_AVOID_FOCUS cannot receive keyboard focus - \c B_WILL_ACCEPT_FIRST_CLICK The first click is processed by the window. - - \c B_OUTLINE_RESIZE draws only it's outline as it's resized and + - \c B_OUTLINE_RESIZE draws only its outline as it's resized and doesn't draw its contents. - \c B_NO_WORKSPACE_ACTIVATION Causes the current workspace to stay active when activated on another workspace. diff --git a/docs/user/shared/json.dox b/docs/user/shared/json.dox index 9e58560be5..33a9d3ddf9 100644 --- a/docs/user/shared/json.dox +++ b/docs/user/shared/json.dox @@ -176,7 +176,7 @@ A primary-listener is employed called \c ColorGradientsListener. The primary-listener accepts Json parse events and will relay them to a sub-listener. The sub-listener is implemented to specifically deal with one tier of the inbound data. The sub-listeners are structured in a stack where -the sub-listener at the head of the stack has a pointer to it's parent. The +the sub-listener at the head of the stack has a pointer to its parent. The primary-listener maintains a pointer to the current head of the stack and will direct events to that sub-listener. diff --git a/docs/user/support/Locker.dox b/docs/user/support/Locker.dox index 5521b11580..d1347b8bf6 100644 --- a/docs/user/support/Locker.dox +++ b/docs/user/support/Locker.dox @@ -40,7 +40,7 @@ semaphore. You can imagine that in many cases where you protect of data that \em might be accessed by two or more concurrent threads, but the chances of it happening being very small, the benaphore benefits the - most from it's speed. + most from its speed. The other feature of BLocker that improves basic semaphore handling is that it allows for recursive locks. The following piece of code works with a @@ -127,7 +127,7 @@ Flower::Water(int amount) \param benaphoreStyle If you pass \c true, the locker will be in benaphore style (which is the default option for other constructors). If you pass \c false, the object will completely rely on semaphores for - it's functioning. + its functioning. \see BLocker(const char* name, bool benaphoreStyle) if you also want to set a name.