From 094b8dcf70f188d0f3044e0b3e5d18a98324f1e1 Mon Sep 17 00:00:00 2001 From: Niels Sascha Reedijk Date: Fri, 29 Jan 2021 09:56:28 +0000 Subject: [PATCH] HaikuBook: housekeeping of the netservices documentation Change-Id: I6f9444665e061047bfb024ac0274b69fa1396912 --- docs/user/Doxyfile | 10 ++++++- docs/user/book.dox | 25 +++++++++++++++++ .../{shared => netservices}/Geolocation.dox | 12 ++++---- .../HttpAuthentication.dox | 10 +++---- docs/user/{net => netservices}/HttpForm.dox | 28 +++++++++---------- .../user/{net => netservices}/HttpHeaders.dox | 14 +++++----- .../user/{net => netservices}/HttpRequest.dox | 10 +++---- .../UrlProtocolAsynchronousListener.dox | 10 +++---- .../UrlProtocolListener.dox | 16 +++++------ .../UrlProtocolRoster.dox | 10 +++---- 10 files changed, 89 insertions(+), 56 deletions(-) rename docs/user/{shared => netservices}/Geolocation.dox (92%) rename docs/user/{net => netservices}/HttpAuthentication.dox (93%) rename docs/user/{net => netservices}/HttpForm.dox (93%) rename docs/user/{net => netservices}/HttpHeaders.dox (93%) rename docs/user/{net => netservices}/HttpRequest.dox (95%) rename docs/user/{net => netservices}/UrlProtocolAsynchronousListener.dox (91%) rename docs/user/{net => netservices}/UrlProtocolListener.dox (93%) rename docs/user/{net => netservices}/UrlProtocolRoster.dox (81%) diff --git a/docs/user/Doxyfile b/docs/user/Doxyfile index 7d5c86c00b..8975a0b8d1 100644 --- a/docs/user/Doxyfile +++ b/docs/user/Doxyfile @@ -832,6 +832,7 @@ INPUT = . \ midi \ midi2 \ net \ + netservices \ posix \ shared \ storage \ @@ -856,7 +857,14 @@ INPUT = . \ ../../headers/os/translation \ ../../headers/posix/syslog.h \ ../../src/kits/game/GameProducer.h \ - ../../headers/private/shared/Geolocation.h + ../../headers/private/netservices/Geolocation.h \ + ../../headers/private/netservices/HttpAuthentication.h \ + ../../headers/private/netservices/HttpForm.h \ + ../../headers/private/netservices/HttpHeaders.h \ + ../../headers/private/netservices/HttpRequest.h \ + ../../headers/private/netservices/UrlProtocolAsynchronousListener.h \ + ../../headers/private/netservices/UrlProtocolListener.h \ + ../../headers/private/netservices/UrlProtocolRoster.h # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/docs/user/book.dox b/docs/user/book.dox index caf9ea073a..fff5bbaa2d 100644 --- a/docs/user/book.dox +++ b/docs/user/book.dox @@ -65,6 +65,7 @@ - \ref drivers - \ref keyboard - \ref json + - \ref netservices */ ///// Define main kits ///// @@ -606,4 +607,28 @@ snooze_until(time - Latency(), B_SYSTEM_TIMEBASE); \defgroup json Json Handling \brief Provides for parsing and writing of data in Json encoding. + + \defgroup netservices Experimental Network Services Support + \brief Experimental API to do higher level network requests + + This API currently is marked as experimental. It is part of the + BPrivate::Network namespace, the header files are found at + headers\\private\\netservices, and you have to link your + application to libnetservices.a. */ + + +///// Namespace Documentation ///// + + +//! \brief Internal or experimental API +namespace BPrivate { + /*! + \brief Experimental Network Services API + + See \ref netservices for more information. + */ + namespace Network { + + } +} \ No newline at end of file diff --git a/docs/user/shared/Geolocation.dox b/docs/user/netservices/Geolocation.dox similarity index 92% rename from docs/user/shared/Geolocation.dox rename to docs/user/netservices/Geolocation.dox index 1f3ad11caa..8c5ce5f4f6 100644 --- a/docs/user/shared/Geolocation.dox +++ b/docs/user/netservices/Geolocation.dox @@ -4,23 +4,23 @@ * * Authors: * Adrien Destugues, pulkomandy@pulkomandy.tk - * + * * Corresponds to: - * headers/private/shared/Geolocation.h hrev53611 - * src/kits/shared/Geolocation.cpp hrev53613S + * headers/private/netservices/Geolocation.h hrev54923 + * src/kits/network/libnetservices/Geolocation.cpp hrev54923 */ /*! \file Geolocation.h - \ingroup shared + \ingroup netservices \brief Geolocation and geocoding services. */ /*! - \class BGeolocation - \ingroup shared + \class BPrivate::Network::BGeolocation + \ingroup netservices \brief Geolocation and geocoding services. Geolocation allows to know where the computer is currently located. diff --git a/docs/user/net/HttpAuthentication.dox b/docs/user/netservices/HttpAuthentication.dox similarity index 93% rename from docs/user/net/HttpAuthentication.dox rename to docs/user/netservices/HttpAuthentication.dox index 9c40143409..09c3f81e90 100644 --- a/docs/user/net/HttpAuthentication.dox +++ b/docs/user/netservices/HttpAuthentication.dox @@ -6,19 +6,19 @@ * Adrien Destugues, pulkomandy@pulkomandy.tk * * Corresponds to: - * headers/os/net/HttpAuthentication.h rev 39161 - * src/kits/network/libnetapi/HttpAuthentication.cpp rev 45363 + * headers/private/netservices/HttpAuthentication.h hrev54923 + * src/kits/network/libnetservices/HttpAuthentication.cpp hrev54923 */ /*! \file HttpAuthentication.h - \ingroup network + \ingroup netservices \brief Authentication token for use in HTTP protocol communications. */ /*! - \class BHttpAuthentication - \ingroup network + \class BPrivate::Network::BHttpAuthentication + \ingroup netservices \brief Authentication token for the HTTP protocol. This class allows managing of an authenticated http session. It stores the diff --git a/docs/user/net/HttpForm.dox b/docs/user/netservices/HttpForm.dox similarity index 93% rename from docs/user/net/HttpForm.dox rename to docs/user/netservices/HttpForm.dox index 4e8a402d8e..f9c673a8df 100644 --- a/docs/user/net/HttpForm.dox +++ b/docs/user/netservices/HttpForm.dox @@ -7,21 +7,21 @@ * John Scipione, jscipione@gmail.com * * Corresponds to: - * headers/os/net/HttpForm.h hrev46314 - * src/kits/network/libnetapi/HttpForm.cpp hrev46314 + * headers/private/netservices/HttpForm.h hrev54923 + * src/kits/network/libnetservices/HttpForm.cpp hrev54923 */ /*! \file HttpForm.h - \ingroup network + \ingroup netservices \brief Management of HTTP form data */ /*! - \enum form_type - \ingroup network + \enum BPrivate::Network::form_type + \ingroup netservices */ @@ -36,8 +36,8 @@ /*! - \enum form_content_type - \ingroup network + \enum BPrivate::Network::form_content_type + \ingroup netservices */ @@ -62,8 +62,8 @@ /*! - \class BHttpFormData - \ingroup network + \class BPrivate::Network::BHttpFormData + \ingroup netservices \brief Stores a form data entry sent or received during an HTTP request. Each element in a form is stored in an instance of this class. The values @@ -81,7 +81,7 @@ /*! - \fn BHttpFormData::BHttpFormData(const BString& name, const BPath& value) + \fn BHttpFormData::BHttpFormData(const BString& name, const BPath& file) \brief Construct a BHttpFormData object which value is a file contents */ @@ -199,8 +199,8 @@ /*! - \class BHttpForm - \ingroup network + \class BPrivate::Network::BHttpForm + \ingroup netservices \brief Container for all the BHttpFormData instances making up an HTTP form contents. */ @@ -361,8 +361,8 @@ /*! - \class BHttpForm::Iterator - \ingroup network + \class BPrivate::Network::BHttpForm::Iterator + \ingroup netservices \brief Form Iterator. */ diff --git a/docs/user/net/HttpHeaders.dox b/docs/user/netservices/HttpHeaders.dox similarity index 93% rename from docs/user/net/HttpHeaders.dox rename to docs/user/netservices/HttpHeaders.dox index 574ba7d9db..b93f05908f 100644 --- a/docs/user/net/HttpHeaders.dox +++ b/docs/user/netservices/HttpHeaders.dox @@ -6,19 +6,19 @@ * Adrien Destugues, pulkomandy@pulkomandy.tk * * Corresponds to: - * headers/os/net/HttpHeaders.h rev 39161 - * src/kits/network/libnetapi/HttpHeaders.cpp rev 45253 + * headers/private/netservices/HttpHeaders.h hrev54923 + * src/kits/network/libnetservices/HttpHeaders.cpp hrev54923 */ /*! \file HttpHeaders.h - \ingroup network + \ingroup netservices \brief Management of HTTP headers */ /*! - \class BHttpHeader - \ingroup network + \class BPrivate::Network::BHttpHeader + \ingroup netservices \brief Represent a single header field for an HTTP connection HTTP headers are key-value pairs, where both the key and the value are @@ -110,8 +110,8 @@ */ /*! - \class BHttpHeaders - \ingroup network + \class BPrivate::Network::BHttpHeaders + \ingroup netservices \brief Container for a set of HTTP headers. This class allows management of the set of headers for a single HTTP diff --git a/docs/user/net/HttpRequest.dox b/docs/user/netservices/HttpRequest.dox similarity index 95% rename from docs/user/net/HttpRequest.dox rename to docs/user/netservices/HttpRequest.dox index 999b74bc0e..cf40b48cd4 100644 --- a/docs/user/net/HttpRequest.dox +++ b/docs/user/netservices/HttpRequest.dox @@ -7,21 +7,21 @@ * John Scipione, jscipione@gmail.com * * Corresponds to: - * headers/os/net/HttpRequest.h hrev46314 - * src/kits/network/libnetapi/HttpRequest.cpp hrev46314 + * headers/private/netservices/HttpRequest.h hrev54923 + * src/kits/network/libnetservices/HttpRequest.cpp hrev54923 */ /*! \file HttpRequest.h - \ingroup network + \ingroup netservices \brief Management of HTTP or HTTPS protocol requests */ /*! - \class BHttpRequest - \ingroup network + \class BPrivate::Network::BHttpRequest + \ingroup netservices \brief Handles a request over HTTP or HTTPS. Instances of ths class will be created by the BUrlProtocolRoster for diff --git a/docs/user/net/UrlProtocolAsynchronousListener.dox b/docs/user/netservices/UrlProtocolAsynchronousListener.dox similarity index 91% rename from docs/user/net/UrlProtocolAsynchronousListener.dox rename to docs/user/netservices/UrlProtocolAsynchronousListener.dox index 676fd34f37..9bbce7639e 100644 --- a/docs/user/net/UrlProtocolAsynchronousListener.dox +++ b/docs/user/netservices/UrlProtocolAsynchronousListener.dox @@ -6,21 +6,21 @@ * Leorize, leorize+oss@disroot.org * * Corresponds to: - * headers/os/net/UrlProtocolAsynchronousListener.h hrev54280 - * src/kits/network/libnetapi/UrlProtocolAsynchronousListener.cpp hrev54280 + * headers/private/netservices/UrlProtocolAsynchronousListener.h hrev54923 + * src/kits/network/libnetapi/UrlProtocolAsynchronousListener.cpp hrev54923 */ /*! \file UrlProtocolAsynchronousListener.h - \ingroup network + \ingroup netservices \brief Provides the BUrlProtocolAsynchronousListener interface. */ /*! - \class BUrlProtocolAsynchronousListener - \ingroup network + \class BPrivate::Network::BUrlProtocolAsynchronousListener + \ingroup netservices \brief Provides a handler for BUrlProtocolDispatchingListener. BUrlProtocolAsynchronousListener transparently handles BMessage issued by diff --git a/docs/user/net/UrlProtocolListener.dox b/docs/user/netservices/UrlProtocolListener.dox similarity index 93% rename from docs/user/net/UrlProtocolListener.dox rename to docs/user/netservices/UrlProtocolListener.dox index 113721f013..abd48048a4 100644 --- a/docs/user/net/UrlProtocolListener.dox +++ b/docs/user/netservices/UrlProtocolListener.dox @@ -6,20 +6,20 @@ * Leorize, leorize+oss@disroot.org * * Corresponds to: - * headers/os/net/UrlProtocolListener.h hrev54280 - * src/kits/network/libnetapi/UrlProtocolListener.cpp hrev54280 + * headers/private/netservices/UrlProtocolListener.h hrev54923 + * src/kits/network/libnetapi/UrlProtocolListener.cpp hrev54923 */ /*! \file UrlProtocolListener.h - \ingroup network + \ingroup netservices \brief Provides the BUrlProtocolListener abstract interface. */ /*! - \enum BUrlProtocolDebugMessage + \enum BPrivate::Network::BUrlProtocolDebugMessage \brief The type of the debug message. */ @@ -61,8 +61,8 @@ /*! - \class BUrlProtocolListener - \ingroup network + \class BPrivate::Network::BUrlProtocolListener + \ingroup netservices \brief Abstract interface for handling BUrlRequest events. BUrlProtocolListener is the base class for handling networking events from @@ -129,7 +129,7 @@ /*! \fn virtual void BUrlProtocolListener::DownloadProgress(BUrlRequest* caller, - ssize_t bytesReceived, ssize_t bytesTotal) + off_t bytesReceived, off_t bytesTotal) \brief Called each time a block of data is downloaded. This callback will usually be called after DataReceived(). @@ -147,7 +147,7 @@ /*! \fn virtual void BUrlProtocolListener::UploadProgress(BUrlRequest* caller, - ssize_t bytesSent, ssize_t bytesTotal) + off_t bytesSent, off_t bytesTotal) \brief Called each time a block of data is sent. \note Currently this callback is never called. diff --git a/docs/user/net/UrlProtocolRoster.dox b/docs/user/netservices/UrlProtocolRoster.dox similarity index 81% rename from docs/user/net/UrlProtocolRoster.dox rename to docs/user/netservices/UrlProtocolRoster.dox index c17944019e..542e04ef28 100644 --- a/docs/user/net/UrlProtocolRoster.dox +++ b/docs/user/netservices/UrlProtocolRoster.dox @@ -6,21 +6,21 @@ * Leorize, leorize+oss@disroot.org * * Corresponds to: - * headers/os/net/UrlProtocolRoster.h hrev54280 - * src/kits/network/libnetapi/UrlProtocolRoster.cpp hrev54280 + * headers/private/netservices/UrlProtocolRoster.h hrev54923 + * src/kits/network/libnetservices/UrlProtocolRoster.cpp hrev54923 */ /*! \file UrlProtocolRoster.h - \ingroup network + \ingroup netservices \brief Provides the BUrlProtocolRoster interface. */ /*! - \class BUrlProtocolRoster - \ingroup network + \class BPrivate::Network::BUrlProtocolRoster + \ingroup netservices \brief Interfaces for protocol-agnostic operations. */