From leorize <leorize+oss@xxxxxxxxxxx>:
leorize has uploaded this change for review. (
https://review.haiku-os.org/c/haiku/+/2983 ;)
Change subject: docs/user/net: add BUrlResult documentation
......................................................................
docs/user/net: add BUrlResult documentation
Change-Id: I94d7c258da60b2fa7add446dfc37aba0a14f6241
---
A docs/user/net/UrlResult.dox
1 file changed, 123 insertions(+), 0 deletions(-)
git pull ssh://git.haiku-os.org:22/haiku refs/changes/83/2983/1
diff --git a/docs/user/net/UrlResult.dox b/docs/user/net/UrlResult.dox
new file mode 100644
index 0000000..302578b
--- /dev/null
+++ b/docs/user/net/UrlResult.dox
@@ -0,0 +1,123 @@
+/*
+ * Copyright 2020 Haiku, Inc. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ * Leorize, leorize+oss@xxxxxxxxxxx
+ *
+ * Corresponds to:
+ * headers/os/net/UrlResult.h hrev54384
+ * src/kits/network/libnetapi/UrlResult.cpp hrev54384
+ */
+
+
+/*!
+ \file UrlResult.h
+ \ingroup network
+ \brief Provides the BUrlResult class.
+*/
+
+
+/*!
+ \class BUrlResult
+ \ingroup network
+ \brief The result of a request made with BUrlRequest.
+
+ This class mainly contains the metadata acquired during a request made
+ with BUrlRequest.
+*/
+
+
+/*!
+ \fn BUrlResult::BUrlResult()
+ \brief Create an uninitialized BUrlResult object.
+*/
+
+
+/*!
+ \fn BUrlResult::BUrlResult(BMessage* archive)
+ \brief Create a BUrlResult object from a BMessage.
+
+ \param archive The BMessage used to construct the object.
+
+ \note Instantiate() should be used instead to verify whether the
BMessage
+ can be used to construct the object.
+*/
+
+
+/*!
+ \fn virtual BUrlResult::~BUrlResult()
+ \brief The default destructor for BUrlResult.
+
+ This destructor free resources held by the BUrlResult object.
+*/
+
+
+/*!
+ \fn virtual status_t BUrlResult::Archive(BMessage* archive, bool deep)
const
+ \brief Archive the object into a BMessage.
+
+ \param archive Pointer to the BMessage object to archive into.
+ \param deep If \c true, all children of this object should be archived
as
+ well.
+
+ \retval B_OK The operation was successful.
+ \retval B_BAD_VALUE \a archive was \c NULL.
+ \retval B_ERROR An error occurred.
+
+ \sa Instantiate() for construcing the object from the archived BMessage.
+*/
+
+
+/*!
+ \fn void BUrlResult::SetContentType(BString contentType)
+ \brief Set the content type of the response.
+
+ This method is mainly used by a BUrlRequest object to set the content
type
+ of the response.
+
+ \param contentType The content type to set to.
+
+ \sa ContentType() for retrieving the set content type.
+*/
+
+
+/*!
+ \fn void BUrlResult::SetLength(size_t length)
+ \brief Set the length of the response.
+
+ This method is mainly used by a BUrlRequest object to set the length of
+ the response.
+
+ \param length The length to set to.
+
+ \sa Length() for retrieving the set length.
+*/
+
+
+/*!
+ \fn virtual BString BUrlResult::ContentType() const
+ \brief Get the content type of the response.
+
+ \sa SetContentType() for setting the content type to be returned by this
+ method.
+*/
+
+
+/*!
+ \fn virtual size_t BUrlResult::Length() const
+ \brief Get the length of the response.
+
+ \sa SetLength() for setting the length to be returned by this method.
+*/
+
+
+/*!
+ \fn static BArchivable* BUrlResult::Instantiate(BMessage* archive)
+ \brief Create a BUrlResult object from a BMessage.
+
+ \param archive The BMessage to construct a BUrlResult from.
+
+ \returns A pointer to the created BUrlResult, or \c NULL if unarchival
+ failed.
+*/
--
To view, visit https://review.haiku-os.org/c/haiku/+/2983
To unsubscribe, or for help writing mail filters, visit
https://review.haiku-os.org/settings
Gerrit-Project: haiku
Gerrit-Branch: master
Gerrit-Change-Id: I94d7c258da60b2fa7add446dfc37aba0a14f6241
Gerrit-Change-Number: 2983
Gerrit-PatchSet: 1
Gerrit-Owner: leorize <leorize+oss@xxxxxxxxxxx>
Gerrit-MessageType: newchange
