hrev53498 adds 5 changesets to branch 'master'
old head: 19017f3f47bd6947139f29fbd53c4530e2eb915d
new head: 4679af2788a14265fee1189a1473225039ff21f4
overview:
https://git.haiku-os.org/haiku/log/?qt=range&q=4679af2788a1+%5E19017f3f47bd
----------------------------------------------------------------------------
f6be862fc503: API Docs: small fix for InterfaceDefs.dox
97ae75c75b18: API Docs: add missing methods of class BView
eaf8dff0734f: API Docs: add skeletons for BUrl and BAlignment and complete
BAlert
2afda31c8fb8: API Docs: add skeletons for BBufferedDataIO, BStringList and
BStackOrHeapArray
4679af2788a1: API Docs: add various missing elements to support kit.
* Adds missing methods to BArchivable, BList and BString.
* Add missing defines to SupportDefs.h
[ Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx> ]
----------------------------------------------------------------------------
12 files changed, 2354 insertions(+), 30 deletions(-)
docs/user/interface/Alert.dox | 101 +++++
docs/user/interface/Alignment.dox | 209 +++++++++
docs/user/interface/InterfaceDefs.dox | 2 +-
docs/user/interface/View.dox | 324 +++++++++++++-
docs/user/support/Archivable.dox | 26 ++
docs/user/support/BufferedDataIO.dox | 153 +++++++
docs/user/support/List.dox | 24 +-
docs/user/support/StackOrHeapArray.dox | Bin 0 -> 2738 bytes
docs/user/support/String.dox | 79 +++-
docs/user/support/StringList.dox | 470 ++++++++++++++++++++
docs/user/support/SupportDefs.dox | 314 ++++++++++++-
docs/user/support/Url.dox | 682 +++++++++++++++++++++++++++++
############################################################################
Commit: f6be862fc503f80e4a4d62734823097aac93e50c
URL: https://git.haiku-os.org/haiku/commit/?id=f6be862fc503
Author: Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
Date: Thu Sep 5 05:30:45 2019 UTC
API Docs: small fix for InterfaceDefs.dox
----------------------------------------------------------------------------
diff --git a/docs/user/interface/InterfaceDefs.dox
b/docs/user/interface/InterfaceDefs.dox
index 5c8a2f3346..cc220ff8d6 100644
--- a/docs/user/interface/InterfaceDefs.dox
+++ b/docs/user/interface/InterfaceDefs.dox
@@ -79,9 +79,9 @@
\var orientation B_HORIZONTAL
Horizontal alignment
-*/
\since BeOS R3
+*/
/*!
############################################################################
Commit: 97ae75c75b1847171b9289ff2f54167baf66d1f5
URL: https://git.haiku-os.org/haiku/commit/?id=97ae75c75b18
Author: Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
Date: Thu Sep 5 05:33:22 2019 UTC
API Docs: add missing methods of class BView
----------------------------------------------------------------------------
diff --git a/docs/user/interface/View.dox b/docs/user/interface/View.dox
index 1193260b2f..90ea62b184 100644
--- a/docs/user/interface/View.dox
+++ b/docs/user/interface/View.dox
@@ -1,5 +1,5 @@
/*
- * Copyright 2011-2015 Haiku, Inc. All rights reserved.
+ * Copyright 2011-2015, 2019 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
@@ -7,8 +7,8 @@
* Joseph Groover, looncraz@xxxxxxxxxxxx
*
* Corresponds to:
- * headers/os/interface/View.h hrev497**
- * src/kits/interface/View.cpp hrev497**
+ * headers/os/interface/View.h hrev52835
+ * src/kits/interface/View.cpp hrev53446
*/
@@ -912,6 +912,15 @@ SetViewColor(Parent()->ViewColor());
*/
+/*!
+ \fn virtual void BView::LayoutChanged()
+ \brief Hook function that is called when the layout if this view, or
one of
+ its children, has changed.
+
+ \since Haiku R1
+*/
+
+
/*!
\fn void BView::LayoutInvalidated(bool descendants)
\brief Hook method called when the layout is invalidated.
@@ -1661,7 +1670,18 @@ SetViewColor(Parent()->ViewColor());
/*!
- \fn void BView::ScrollTo(BPoint where)
+ \fn void BView::ScrollTo(float x, float y)
+ \brief Scroll the view to the point specified by coordinates.
+
+ \param x The x-coordinate to scroll the view to.
+ \param y The y-coordinate to scroll the view to.
+
+ \since BeOS R3
+*/
+
+
+/*!
+ \fn virtual void BView::ScrollTo(BPoint where)
\brief Scroll the view to the point specified by \a where.
\param where The location to scroll the view to.
@@ -1837,6 +1857,70 @@ SetViewColor(Parent()->ViewColor());
*/
+/*!
+ \fn void BView::SetTransform(BAffineTransform transform)
+ \brief Sets a BAffineTransform to transform the coordinate system
+
+ \sa See Transform() to get the current transformations, and
TranslateBy(),
+ ScaleBy() and RotateBy() for additional transformation options.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BAffineTransform BView::Transform() const
+ \brief Returns the current BAffineTransform that is applied to the
+ coordinate system
+
+ \sa SetTransform()
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BView::TranslateBy(double x, double y)
+ \brief Translate the current view by coordinates.
+
+ The translation of \a x and \a y are applied to the current
transformation,
+ not instead of, so it is an additive action.
+
+ \sa See Transform() to get the current transformations, SetTransform(),
+ ScaleBy() and RotateBy() for additional transformation options.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BView::ScaleBy(double x, double y)
+ \brief Scale the current view by factors \a x and \a y.
+
+ The scaling with factors \a x and \a y are applied to the current
+ transformation, not instead of, so it is an additive action.
+
+ \sa See Transform() to get the current transformations, SetTransform(),
+ TranslateBy() and RotateBy() for additional transformation options.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BView::RotateBy(double angleRadians)
+ \brief Rotate the current view by \a angleRadians.
+
+ The rotation is applied to the current transformation, not instead of,
so
+ it is an additive action.
+
+ \sa See Transform() to get the current transformations, SetTransform(),
+ ScaleBy() and TranslateBy() for additional transformation options.
+
+ \since Haiku R1
+*/
+
+
/*!
\fn void BView::SetScale(float scale) const
\brief Sets the scale of the coordinate system the view uses for
drawing.
@@ -1940,6 +2024,38 @@ SetViewColor(Parent()->ViewColor());
*/
+/*!
+ \fn void BView::SetFillRule(int32 rule)
+ \brief Sets the fill rule for the view.
+
+ A fill rule is a rule that describes an algorithm that is used to find
out
+ what the inside of a shape is. The concept comes from the SVG format.
+
+ See <a
href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule";>
+ the Mozilla documentation on the fill property of SVG</a> for more
+ information.
+
+ \param rule There are two algorithms: the \c B_NONZERO and the
+ \c B_EVEN_ODD algorithm.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BView::FillRule() const
+ \brief Return the current fill mode.
+
+ See BView::SetFillRule() for more information.
+
+ \returns Returns \c 0 if no fill rule is applied, \c B_EVEN_ODD when the
+ even-odd algorithm is applied, and \c B_NONZERO if the nonzero
+ algorithm is applied.
+
+ \since Haiku R1
+*/
+
+
/*!
\fn void BView::SetDrawingMode(drawing_mode mode)
\brief Sets the drawing mode of the view.
@@ -2487,6 +2603,54 @@ SetViewColor(Parent()->ViewColor());
*/
+/*!
+ \fn void BView::ClipToRect(BRect rect)
+ \brief Intersects the current clipping region of the view with the
pixels
+ of \a rect.
+
+ \param rect The BRect that describes the rectangle to intersect with.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BView::ClipToInverseRect(BRect rect)
+ \brief Intersects the current clipping region of the view with the
pixels
+ outside of \a rect.
+
+ \param rect The BRect that describes the rectangle to intersect with.
+
+ \see ClipToRect()
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BView::ClipToShape(BShape* shape)
+ \brief Intersects the current clipping region of the view with the
pixels
+ of \a shape.
+
+ \param shape The BShape that describes the area to intersect with.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BView::ClipToInverseShape(BShape* shape)
+ \brief Intersects the current clipping region of the view with the
pixels
+ outside of \a shape.
+
+ \param shape The BShape that describes the area to intersect with.
+
+ \see ClipToShape()
+
+ \since Haiku R1
+*/
+
+
/*!
\fn void BView::GetClippingRegion(BRegion* region) const
\brief Fill out \a region with the view's clipping region.
@@ -3814,6 +3978,43 @@ SetViewColor(Parent()->ViewColor());
*/
+/*!
+ \fn void BView::BeginLayer(uint8 opacity)
+ \brief Begins a drawing layer.
+
+ This feature of BView allows you to create a separate layer, draw on it,
+ and blend it in with the rest of the view with a given \a opacity.
+ Internally, the method creates a new drawing buffer, that you can draw
on
+ using the methods of BView. After finishing your layer, you call
EndLayer()
+ to apply the \a opacity to the layer, and blend it in with the existing
+ drawing.
+
+ You can nest layers, meaning you can call this method while drawing a
+ layer, to create a sublayer. The layers are mixed and blended in order.
+
+ This work was done to support drawing for WebKit.
+
+ \sa EndLayer()
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BView::EndLayer()
+ \brief Finish a layer and blend it in with the view.
+
+ This is the counterpart to BeginLayer(). You can nest multiple layer. If
+ this method is called and the current layer is nested in another layer,
the
+ current layer is applied to the layer above. If this is the only layer,
it
+ will directly blend in to the main view.
+
+ \sa BeginLayer()
+
+ \since Haiku R`
+*/
+
+
/*!
\fn void BView::Invalidate(BRect invalRect)
\brief Sends a message to App Server to redraw the portion of the view
@@ -4186,6 +4387,16 @@ SetViewColor(Parent()->ViewColor());
*/
+/*!
+ \fn virtual BAlignment BView::LayoutAlignment()
+ \brief Return the current BAlignemnt of the view.
+
+ \remark This is only meaningful if the view is part of a BLayout.
+
+ \since Haiku R1
+*/
+
+
/*!
\fn void BView::SetExplicitMinSize(BSize size)
\brief Set this view's min size, to be used by MinSize().
@@ -4222,6 +4433,19 @@ SetViewColor(Parent()->ViewColor());
*/
+/*!
+ \fn void BView::SetExplicitSize(BSize size)
+ \brief Set this view's size.
+
+ \remark This is only meaningful if the view is part of a BLayout.
+
+ This is a convenience function that calls both SetExplicitMinSize()
+ and SetExplicitMaxSize() with the \a size parameter.
+
+ \since Haiku R1
+*/
+
+
/*!
\fn void BView::SetExplicitAlignment(BAlignment alignment)
\brief Set this view's alignment, to be used by Alignment().
@@ -4234,6 +4458,86 @@ SetViewColor(Parent()->ViewColor());
*/
+/*!
+ \fn BSize BView::ExplicitMinSize() const
+ \brief Returns the explicit minimum size.
+
+ \remark This is only meaningful if the view is part of a BLayout.
+
+ This returns the value that was set by SetExplicitMinSize().
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BSize BView::ExplicitMaxSize() const
+ \brief Returns the explicit maximum size.
+
+ \remark This is only meaningful if the view is part of a BLayout.
+
+ This returns the value that was set by SetExplicitMaxSize().
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BSize BView::ExplicitPreferredSize() const
+ \brief Returns the explicit preferred size.
+
+ \remark This is only meaningful if the view is part of a BLayout.
+
+ This returns the value that was set by SetExplicitPreferredSize().
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BSize BView::ExplicitAlignment() const
+ \brief Returns the explicit alignment size.
+
+ \remark This is only meaningful if the view is part of a BLayout.
+
+ This returns the value that was set by SetExplicitAlignment().
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BView::HasHeightForWidth()
+ \brief Returns whether the layout of the view can calculate a height
for a
+ given width.
+
+ \remark This is only meaningful if the view is part of a BLayout.
+
+ Use GetHeightForWidth() to actually get the preferred size.
+
+ \returns \c true if the height values can be calculated, \c false if
they
+ cannot.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual void BView::GetHeightForWidth(float width, float* min,
+ float* max, float* preferred)
+ \brief Returns the min, max and preferred height for a given width.
+
+ \remark This is only meaningful if the view is part of a BLayout.
+
+ \param[in] width The width you want the height to be calculated for.
+ \param[out] min The minimum height that the layout will request.
+ \param[out] max The maximum height that the layout will request.
+ \param[out] preferred The preferred height for this \a width.
+
+ \since Haiku R1
+*/
+
+
/*!
\fn void BView::SetLayout(BLayout* layout)
\brief Sets the \a layout of the view.
@@ -4306,7 +4610,7 @@ SetViewColor(Parent()->ViewColor());
\remark This is only meaningful if the view is part of a BLayout.
- \brief Returns \c true if the layout is valid, \c false otherwise.
+ \returns Returns \c true if the layout is valid, \c false otherwise.
\since Haiku R1
*/
@@ -4329,6 +4633,16 @@ SetViewColor(Parent()->ViewColor());
*/
+/*!
+ \fn BLayoutContext* BView::LayoutContext() const
+ \brief Returns the BLayoutContext for this View.
+
+ \remark This is only meaningful if the view is part of a BLayout.
+
+ \since Haiku R1
+*/
+
+
/*!
\fn void BView::Layout(bool force)
\brief Layout the view.
############################################################################
Commit: eaf8dff0734f5c76f8fdc7a2a328dbd6b363ac54
URL: https://git.haiku-os.org/haiku/commit/?id=eaf8dff0734f
Author: Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
Date: Mon Sep 9 20:12:13 2019 UTC
API Docs: add skeletons for BUrl and BAlignment and complete BAlert
----------------------------------------------------------------------------
diff --git a/docs/user/interface/Alert.dox b/docs/user/interface/Alert.dox
index 89a11cf601..387aa911ac 100644
--- a/docs/user/interface/Alert.dox
+++ b/docs/user/interface/Alert.dox
@@ -22,6 +22,7 @@
/*!
\enum alert_type
\ingroup interface
+ \brief Type of alert.
Determines which icon (if any) is displayed in the alert dialog.
Choose one option. If the constructor doesn't include an
@@ -83,6 +84,7 @@
/*!
\enum button_spacing
\ingroup interface
+ \brief Method of spacing of buttons in alerts.
Determines how the buttons on the alert dialog are spaced relative
to each other. Choose one option. If the constructor doesn't include a
@@ -169,6 +171,21 @@ int32 button_index = alert->Go();
*/
+/*!
+ \fn BAlert::BAlert()
+ \brief Create an unconfigured BAlert dialog.
+
+ This method creates an unconfigured BAlert. You can configure it with
+ methods like SetText(), SetType() and SetButtonSpacing.
+
+ It is advised to use one of the other constructors that help set up all
+ the configuration in one go, instead of doing it piece by piece with
this
+ method.
+
+ \since BeOS R3
+*/
+
+
/*!
\fn BAlert::BAlert(const char* title, const char* text,
const char* button1, const char* button2, const char* button3,
@@ -302,6 +319,67 @@ int32 button_index = alert->Go();
//! @}
+/*!
+ \fn alert_type BAlert::Type() const
+ \brief Get the alert_type of this alert.
+
+ \return Returns one of the values from the alert_type enum.
+
+ \since BeOS R3
+*/
+
+
+/*!
+ \fn void BAlert::SetType(alert_type type)
+ \brief Set the type of the alert.
+
+ \param type Pass one of the alert_type enum values to set the type.
+
+ \since BeOS R3
+*/
+
+
+/*!
+ \fn void BAlert::SetIcon(BBitmap *bitmap)
+ \brief Set a custom icon for the alert.
+
+ \param bitmap A valid BBitmap. The bitmap is copied.
+
+ \since BeOS R3
+*/
+
+
+/*!
+ \fn void BAlert::SetText(const char *text)
+ \brief Set the text for the alert.
+
+ \param text The text you want the alert to display.
+
+ \since BeOS R3
+*/
+
+
+/*!
+ \fn void BAlert::SetButtonSpacing(button_spacing spacing)
+ \brief Set the button spacing for the alert.
+
+ \param spacing Pass one of the button_spacing values to configure the
+ spacing.
+
+ \since BeOS R3
+*/
+
+
+/*!
+ \fn void BAlert::SetButtonWidth(button_width width)
+ \brief Set the button width for the buttons of the alert.
+
+ \param width Pass one of the button_width values to configure the width.
+
+ \since BeOS R3
+*/
+
+
/*!
\fn void BAlert::SetShortcut(int32 index, char key)
\brief Sets the shortcut character which is mapped to a button at the
@@ -390,6 +468,29 @@ int32 button_index = alert->Go();
*/
+/*!
+ \fn void BAlert::AddButton(const char *label, char key=0)
+ \brief Adds a button to the alert.
+
+ \param label The label of the button.
+ \param key The key a user can press to quickly select this button.
+
+ \since BeOS R3
+*/
+
+
+/*!
+ \fn int32 BAlert::CountButtons() const
+ \brief Counts the number of buttons in the alert.
+
+ \return The number of buttons in this alert window.
+
+ \see AddButton() and ButtonAt()
+
+ \since BeOS R3
+*/
+
+
/*!
\fn BButton* BAlert::ButtonAt(int32 index) const
\brief Returns a pointer to the BButton at the specified \a index.
diff --git a/docs/user/interface/Alignment.dox
b/docs/user/interface/Alignment.dox
new file mode 100644
index 0000000000..debd7cb911
--- /dev/null
+++ b/docs/user/interface/Alignment.dox
@@ -0,0 +1,209 @@
+/*
+ * Copyright 2019 Haiku, Inc. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ * Name, email@xxxxxxxxx
+ *
+ * Corresponds to:
+ * headers/os/interface/Alignment.h hrev32745
+ * src/kits/interface/Alignment.cpp hrev18649
+ */
+
+
+/*!
+ \file Alignment.h
+ \ingroup interface
+ \brief Undocumented file.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \class BAlignment
+ \ingroup interface
+ \ingroup libbe
+ \brief Undocumented class.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \var alignment BAlignment::horizontal
+ \brief Undocumented public variable
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \var vertical_alignment BAlignment::vertical
+ \brief Undocumented public variable
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BAlignment::BAlignment()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BAlignment::BAlignment(const BAlignment &other)
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BAlignment::BAlignment(alignment horizontal, vertical_alignment
vertical)
+ \brief Undocumented public method
+
+ \param horizontal Undocumented
+ \param vertical Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn alignment BAlignment::Horizontal() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn vertical_alignment BAlignment::Vertical() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn float BAlignment::RelativeHorizontal() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn float BAlignment::RelativeVertical() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BAlignment::SetHorizontal(alignment horizontal)
+ \brief Undocumented public method
+
+ \param horizontal Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BAlignment::SetVertical(vertical_alignment vertical)
+ \brief Undocumented public method
+
+ \param vertical Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BAlignment::IsHorizontalSet() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BAlignment::IsVerticalSet() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BAlignment::operator==(const BAlignment &other) const
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BAlignment::operator!=(const BAlignment &other) const
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BAlignment & BAlignment::operator=(const BAlignment &other)
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
diff --git a/docs/user/support/Url.dox b/docs/user/support/Url.dox
new file mode 100644
index 0000000000..3ffe04a25d
--- /dev/null
+++ b/docs/user/support/Url.dox
@@ -0,0 +1,682 @@
+/*
+ * Copyright 2019 Haiku, Inc. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ * Name, email@xxxxxxxxx
+ *
+ * Corresponds to:
+ * headers/os/support/Url.h hrev52332
+ * src/kits/support/Url.cpp hrev52332
+ */
+
+
+/*!
+ \file Url.h
+ \ingroup support
+ \brief Undocumented file.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \class BUrl
+ \ingroup support
+ \ingroup libbe
+ \brief Undocumented class.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl::BUrl(const char *url)
+ \brief Undocumented public method
+
+ \param url Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl::BUrl(BMessage *archive)
+ \brief Undocumented public method
+
+ \param archive Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl::BUrl(const BUrl &other)
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl::BUrl(const BUrl &base, const BString &relative)
+ \brief Undocumented public method
+
+ \param base Undocumented
+ \param relative Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl::BUrl(const BPath &path)
+ \brief Undocumented public method
+
+ \param path Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl::BUrl()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual virtual BUrl::~BUrl()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl& BUrl::SetUrlString(const BString &url)
+ \brief Undocumented public method
+
+ \param url Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl& BUrl::SetProtocol(const BString &scheme)
+ \brief Undocumented public method
+
+ \param scheme Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl& BUrl::SetUserName(const BString &user)
+ \brief Undocumented public method
+
+ \param user Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl& BUrl::SetPassword(const BString &password)
+ \brief Undocumented public method
+
+ \param password Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BUrl::SetAuthority(const BString &authority)
+ \brief Undocumented public method
+
+ \param authority Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl& BUrl::SetHost(const BString &host)
+ \brief Undocumented public method
+
+ \param host Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl& BUrl::SetPort(int port)
+ \brief Undocumented public method
+
+ \param port Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl& BUrl::SetPath(const BString &path)
+ \brief Undocumented public method
+
+ \param path Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl& BUrl::SetRequest(const BString &request)
+ \brief Undocumented public method
+
+ \param request Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl& BUrl::SetFragment(const BString &fragment)
+ \brief Undocumented public method
+
+ \param fragment Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BString& BUrl::UrlString() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BString& BUrl::Protocol() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BString& BUrl::UserName() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BString& BUrl::Password() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BString& BUrl::UserInfo() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BString& BUrl::Host() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int BUrl::Port() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BString& BUrl::Authority() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BString& BUrl::Path() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BString& BUrl::Request() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BString& BUrl::Fragment() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::IsValid() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::HasProtocol() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::HasUserName() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::HasPassword() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::HasUserInfo() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::HasHost() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::HasPort() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::HasAuthority() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::HasPath() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::HasRequest() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::HasFragment() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BUrl::UrlEncode(bool strict=false)
+ \brief Undocumented public method
+
+ \param strict Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BUrl::UrlDecode(bool strict=false)
+ \brief Undocumented public method
+
+ \param strict Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BUrl::IDNAToAscii()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BUrl::IDNAToUnicode()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::HasPreferredApplication() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BString BUrl::PreferredApplication() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BUrl::OpenWithPreferredApplication(bool
onProblemAskUser=true) const
+ \brief Undocumented public method
+
+ \param onProblemAskUser Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::operator==(BUrl &other) const
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BUrl::operator!=(BUrl &other) const
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BUrl& BUrl::operator=(const BUrl &other)
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BUrl& BUrl::operator=(const BString &string)
+ \brief Undocumented public method
+
+ \param string Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn const BUrl& BUrl::operator=(const char *string)
+ \brief Undocumented public method
+
+ \param string Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BUrl::operator const char *() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static static BString BUrl::UrlEncode(const BString &url, bool
strict=false, bool directory=false)
+ \brief Undocumented public method
+
+ \param url Undocumented
+ \param strict Undocumented
+ \param directory Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static static BString BUrl::UrlDecode(const BString &url, bool
strict=false)
+ \brief Undocumented public method
+
+ \param url Undocumented
+ \param strict Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn static static BArchivable* BUrl::Instantiate(BMessage *archive)
+ \brief Undocumented public method
+
+ \param archive Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
############################################################################
Commit: 2afda31c8fb8cb2fbbf2801dc585f9c8c4eedc99
URL: https://git.haiku-os.org/haiku/commit/?id=2afda31c8fb8
Author: Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
Date: Wed Sep 18 05:32:53 2019 UTC
API Docs: add skeletons for BBufferedDataIO, BStringList and BStackOrHeapArray
----------------------------------------------------------------------------
diff --git a/docs/user/support/BufferedDataIO.dox
b/docs/user/support/BufferedDataIO.dox
new file mode 100644
index 0000000000..ad8b73ad65
--- /dev/null
+++ b/docs/user/support/BufferedDataIO.dox
@@ -0,0 +1,153 @@
+/*
+ * Copyright 2019 Haiku, Inc. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ * Name, email@xxxxxxxxx
+ *
+ * Corresponds to:
+ * headers/os/support/BufferedDataIO.h hrev47422
+ * src/kits/support/BufferedDataIO.cpp hrev48615
+ */
+
+
+
+
+/*!
+ \file BufferedDataIO.h
+ \ingroup support
+ \ingroup libbe
+ \brief Undocumented file.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \class BBufferedDataIO
+ \ingroup support
+ \ingroup libbe
+ \brief Undocumented class.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BBufferedDataIO::BBufferedDataIO(BDataIO &stream, size_t
bufferSize=65536L, bool ownsStream=true, bool partialReads=false)
+ \brief Undocumented public method
+
+ \param stream Undocumented
+ \param bufferSize Undocumented
+ \param ownsStream Undocumented
+ \param partialReads Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual virtual BBufferedDataIO::~BBufferedDataIO()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn status_t BBufferedDataIO::InitCheck() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BDataIO* BBufferedDataIO::Stream() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn size_t BBufferedDataIO::BufferSize() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BBufferedDataIO::OwnsStream() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BBufferedDataIO::SetOwnsStream(bool ownsStream)
+ \brief Undocumented public method
+
+ \param ownsStream Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual status_t BBufferedDataIO::Flush()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual virtual ssize_t BBufferedDataIO::Read(void *buffer, size_t
size)
+ \brief Undocumented public method
+
+ \param buffer Undocumented
+ \param size Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual virtual ssize_t BBufferedDataIO::Write(const void *buffer,
size_t size)
+ \brief Undocumented public method
+
+ \param buffer Undocumented
+ \param size Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
diff --git a/docs/user/support/StackOrHeapArray.dox
b/docs/user/support/StackOrHeapArray.dox
new file mode 100644
index 0000000000..7465b97bf3
Binary files /dev/null and b/docs/user/support/StackOrHeapArray.dox differ
diff --git a/docs/user/support/StringList.dox b/docs/user/support/StringList.dox
new file mode 100644
index 0000000000..1916d6de1d
--- /dev/null
+++ b/docs/user/support/StringList.dox
@@ -0,0 +1,470 @@
+/*
+ * Copyright 2019 Haiku, Inc. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ * Name, email@xxxxxxxxx
+ *
+ * Corresponds to:
+ * headers/os/support/StringList.h hrev47422
+ * src/kits/support/StringList.cpp hrev46113
+ */
+
+
+/*!
+ \file StringList.h
+ \ingroup support
+ \brief Undocumented file.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \class BStringList
+ \ingroup support
+ \ingroup libbe
+ \brief Undocumented class.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BStringList::BStringList(int32 count=20)
+ \brief Undocumented public method
+
+ \param count Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BStringList::BStringList(const BStringList &other)
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual virtual BStringList::~BStringList()
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::Add(const BString &string, int32 index)
+ \brief Undocumented public method
+
+ \param string Undocumented
+ \param index Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::Add(const BString &string)
+ \brief Undocumented public method
+
+ \param string Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::Add(const BStringList &list, int32 index)
+ \brief Undocumented public method
+
+ \param list Undocumented
+ \param index Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::Add(const BStringList &list)
+ \brief Undocumented public method
+
+ \param list Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::Remove(const BString &string, bool
ignoreCase=false)
+ \brief Undocumented public method
+
+ \param string Undocumented
+ \param ignoreCase Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::Remove(const BStringList &list, bool
ignoreCase=false)
+ \brief Undocumented public method
+
+ \param list Undocumented
+ \param ignoreCase Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BString BStringList::Remove(int32 index)
+ \brief Undocumented public method
+
+ \param index Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::Remove(int32 index, int32 count)
+ \brief Undocumented public method
+
+ \param index Undocumented
+ \param count Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::Replace(int32 index, const BString &string)
+ \brief Undocumented public method
+
+ \param index Undocumented
+ \param string Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BStringList::MakeEmpty()
+ \brief Undocumented public method
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BStringList::Sort(bool ignoreCase=false)
+ \brief Undocumented public method
+
+ \param ignoreCase Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::Swap(int32 indexA, int32 indexB)
+ \brief Undocumented public method
+
+ \param indexA Undocumented
+ \param indexB Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::Move(int32 fromIndex, int32 toIndex)
+ \brief Undocumented public method
+
+ \param fromIndex Undocumented
+ \param toIndex Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BString BStringList::StringAt(int32 index) const
+ \brief Undocumented public method
+
+ \param index Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BString BStringList::First() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BString BStringList::Last() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::HasString(const BString &string, bool
ignoreCase=false) const
+ \brief Undocumented public method
+
+ \param string Undocumented
+ \param ignoreCase Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BStringList::IndexOf(const BString &string, bool
ignoreCase=false) const
+ \brief Undocumented public method
+
+ \param string Undocumented
+ \param ignoreCase Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int32 BStringList::CountStrings() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::IsEmpty() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BString BStringList::Join(const char *separator, int32 length=-1)
const
+ \brief Undocumented public method
+
+ \param separator Undocumented
+ \param length Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BStringList::DoForEach(bool(*func)(const BString &string))
+ \brief Undocumented public method
+
+ \param func Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn void BStringList::DoForEach(bool(*func)(const BString &string, void
*arg2), void *arg2)
+ \brief Undocumented public method
+
+ \param func Undocumented
+ \param arg2 Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn BStringList& BStringList::operator=(const BStringList &other)
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::operator==(const BStringList &other) const
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn bool BStringList::operator!=(const BStringList &other) const
+ \brief Undocumented public method
+
+ \param other Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual virtual bool BStringList::IsFixedSize() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual virtual type_code BStringList::TypeCode() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual virtual bool BStringList::AllowsTypeCode(type_code code)
const
+ \brief Undocumented public method
+
+ \param code Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual virtual ssize_t BStringList::FlattenedSize() const
+ \brief Undocumented public method
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual virtual status_t BStringList::Flatten(void *buffer, ssize_t
size) const
+ \brief Undocumented public method
+
+ \param buffer Undocumented
+ \param size Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn virtual virtual status_t BStringList::Unflatten(type_code code,
const void *buffer, ssize_t size)
+ \brief Undocumented public method
+
+ \param code Undocumented
+ \param buffer Undocumented
+ \param size Undocumented
+
+ \return Undocumented
+ \retval <value> Undocumented
+
+ \since Haiku R1
+*/
############################################################################
Revision: hrev53498
Commit: 4679af2788a14265fee1189a1473225039ff21f4
URL: https://git.haiku-os.org/haiku/commit/?id=4679af2788a1
Author: Niels Sascha Reedijk <niels.reedijk@xxxxxxxxx>
Date: Thu Sep 19 20:53:09 2019 UTC
API Docs: add various missing elements to support kit.
* Adds missing methods to BArchivable, BList and BString.
* Add missing defines to SupportDefs.h
----------------------------------------------------------------------------
diff --git a/docs/user/support/Archivable.dox b/docs/user/support/Archivable.dox
index b8db3c2b51..30d431ad1f 100644
--- a/docs/user/support/Archivable.dox
+++ b/docs/user/support/Archivable.dox
@@ -395,6 +395,31 @@
*/
+/*!
+ \enum BUnarchiver::ownership_policy
+ \brief Options for the ownership policy of objects retrieved from
+ BUnarchiver
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \var ownership_policy BUnarchiver::B_ASSUME_OWNERSHIP
+ \brief Ownership of unarchived objects will be transferred to the
caller.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \var ownership_policy BUnarchiver::B_DONT_ASSUME_OWNERSHIP
+ \brief The unarchived objects will be borrowed to the caller.
+
+ \since Haiku R1
+*/
+
+
/*!
\fn BUnarchiver::BUnarchiver(const BMessage* archive)
\brief Constructs a BUnarchiver object to manage \c archive.
@@ -872,3 +897,4 @@ MyArchivableClas::MyArchivableClas(BMessage* archive)
//! @}
+
\ No newline at end of file
diff --git a/docs/user/support/List.dox b/docs/user/support/List.dox
index b8cb9eedff..d459487b81 100644
--- a/docs/user/support/List.dox
+++ b/docs/user/support/List.dox
@@ -12,8 +12,8 @@
* John Drinkwater, jdrinkwater@xxxxxxxxx
*
* Corresponds to:
- * headers/os/support/List.h hrev47418
- * src/kits/support/List.cpp hrev47418
+ * headers/os/support/List.h hrev47422
+ * src/kits/support/List.cpp hrev47422
*/
@@ -480,6 +480,16 @@ A C D E F G B H I J
*/
+/*!
+ \fn bool BList::HasItem(const void *item) const
+ \brief Return whether or not \a item is in the list.
+
+ \return \c true if the \a item was in the list, \c false otherwise.
+
+ \since Haiku R1
+*/
+
+
/*!
\fn int32 BList::IndexOf(void* item) const
\brief Return the index of \a item.
@@ -490,6 +500,16 @@ A C D E F G B H I J
*/
+/*!
+ \fn int32 BList::IndexOf(const void *item) const
+ \brief Return the index of \a item.
+
+ \return The index of the item, or -1 when the item is not in the list.
+
+ \since Haiku R1
+*/
+
+
/*!
\fn int32 BList::CountItems() const
\brief Returns the number of items in the list.
diff --git a/docs/user/support/String.dox b/docs/user/support/String.dox
index 5ddba92263..e0e236410a 100644
--- a/docs/user/support/String.dox
+++ b/docs/user/support/String.dox
@@ -10,8 +10,8 @@
* Oliver Tappe, openbeos@xxxxxxxxxxxxxx
*
* Corresponds to:
- * headers/os/support/String.h rev 43319
- * src/kits/support/String.cpp rev 42682
+ * headers/os/support/String.h rev 50791
+ * src/kits/support/String.cpp rev 52836
*/
@@ -445,6 +445,47 @@
*/
+/*!
+ \fn BString& BString::SetToFormatVarArgs(const char* format, va_list
args)
+ \brief Sets the string to a formatted string ala <tt>sprintf()</tt>.
+
+ \param format The \a format string to use.
+ \param args The rest of the parameters that are filled into \a format.
+
+ \return This method always returns \c *this.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int BString::ScanWithFormat(const char* format, ...)
+ \brief Parse a formatted string and save elements to variables ala
+ <tt>scanf()</tt>.
+
+ \param format The \a format string to use.
+ \param ... The parameters that you want to store the parsed data into.
+
+ \return This method returns the number of items that were parsed.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \fn int BString::ScanWithFormatVarArgs(const char* format, va_list args)
+ \brief Parse a formatted string and save elements to variables ala
+ <tt>scanf()</tt>.
+
+ \param format The \a format string to use.
+ \param args The parameters that you want to store the parsed data into.
+
+ \return This method returns the number of items that were parsed.
+
+ \since Haiku R1
+*/
+
+
//! @}
@@ -1541,6 +1582,27 @@
*/
+/*!
+ \fn int BString::CompareAt(size_t offset, const BString& string,
+ int32 length) const
+ \brief Lexicographically compare \a length of characters of this
BString to
+ another \a string, starting at \a offset.
+
+ \param offset The offset (in bytes) to start comparison.
+ \param string The \a string to compare against.
+ \param length The number of bytes to compare.
+
+ \return An int representing the strings relationship to each other.
+ \retval >0 The BString sorts lexicographically after \a string.
+ \retval =0 The BString is equal to \a string.
+ \retval <0 The BString sorts lexicographically before \a string.
+
+ \sa Compare(const BString&, int32) const
+
+ \since Haiku R1
+*/
+
+
/*!
\fn int BString::CompareChars(const BString& string, int32 charCount)
const
\brief UTF-8 aware version of Compare(const BString&, int32).
@@ -2647,6 +2709,19 @@
*/
+/*!
+ \fn BString& BString::SetByteAt(int32 pos, char to)
+ \brief Set a byte at position \a pos to character \a to.
+
+ \param pos The index of the byte to replace.
+ \param to The new value that should replace the previous byte.
+
+ \return This method always returns \c *this.
+
+ \since Haiku R1
+*/
+
+
//! @}
diff --git a/docs/user/support/SupportDefs.dox
b/docs/user/support/SupportDefs.dox
index 792c2255be..81c4483f25 100644
--- a/docs/user/support/SupportDefs.dox
+++ b/docs/user/support/SupportDefs.dox
@@ -7,7 +7,7 @@
* John Scipione, jscipione@xxxxxxxxx
*
* Corresponds to:
- * headers/os/support/SupportDefs.h rev 35018
+ * headers/os/support/SupportDefs.h hrev51198
*/
@@ -242,11 +242,55 @@
*/
+/*!
+ \typedef typedef __haiku_phys_addr_t phys_addr_t
+ \brief Represents a physical address.
+
+ This has the length of 4 bytes on a 32 bit platform, and 8 bytes on a 64
+ bit platform.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \typedef typedef phys_addr_t phys_size_t
+ \brief Represents a size of physical memory.
+
+ This has the length of 4 bytes on a 32 bit platform, and 8 bytes on a 64
+ bit platform.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \typedef typedef __haiku_generic_addr_t generic_addr_t
+ \brief Represents a generic address.
+
+ A generic address is wide enough to store both physical and virtual
+ addresses.
+
+ \since Haiku R1
+*/
+
+
+/*!
+ \typedef typedef generic_addr_t generic_size_t
+ \brief Represents a size of generic memory.
+
+ A generic address is wide enough to store both physical and virtual
+ addresses.
+
+ \since Haiku R1
+*/
+
+
//! @}
/*!
- \name Format strings for printf() and scanf()
+ \name Format strings for printf() and scanf() for integer types
*/
@@ -255,221 +299,265 @@
/*!
\def B_PRId8
+ \brief printf() constant for i8 as decimal
*/
/*!
\def B_PRIi8
+ \brief printf() constant for i8 as decimal
*/
/*!
\def B_PRId16
+ \brief printf() constant for i16 as decimal
*/
/*!
\def B_PRIi16
+ \brief printf() constant for i16 as decimal
*/
/*!
\def B_PRId32
+ \brief printf() constant for i32 as decimal
*/
/*!
\def B_PRIi32
+ \brief printf() constant for i32 as decimal
*/
/*!
\def B_PRId64
+ \brief printf() constant for i64 as decimal
*/
/*!
\def B_PRIi64
+ \brief printf() constant for i64 as decimal
*/
/*!
\def B_PRIu8
+ \brief printf() constant for u8 as decimal
*/
/*!
\def B_PRIo8
+ \brief printf() constant for u8 as octal
*/
/*!
\def B_PRIx8
+ \brief printf() constant for u8 as lowercase hexadecimal
*/
/*!
\def B_PRIX8
+ \brief printf() constant for u8 as uppercase hexadecimal
*/
/*!
\def B_PRIu16
+ \brief printf() constant for u16 as decimal
*/
/*!
\def B_PRIo16
+ \brief printf() constant for u16 as octal
*/
/*!
\def B_PRIx16
+ \brief printf() constant for u16 as lowercase hexadecimal
*/
/*!
\def B_PRIX16
+ \brief printf() constant for u16 as uppercase hexadecimal
*/
/*!
\def B_PRIu32
+ \brief printf() constant for u32 as decimal
*/
/*!
\def B_PRIo32
+ \brief printf() constant for u32 as octal
*/
/*!
\def B_PRIx32
+ \brief printf() constant for u32 as lowercase hexadecimal
*/
[ *** diff truncated: 473 lines dropped *** ]
