Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HaikuBook: housekeeping of the netservices documentation

Browse Source 
Change-Id: I6f9444665e061047bfb024ac0274b69fa1396912
This commit is contained in:
Niels Sascha Reedijk 2021-01-29 09:56:28 +00:00
parent e95af9e0ef
commit 094b8dcf70
10 changed files with 89 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/user/Doxyfile
View File

@ -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

25
docs/user/book.dox
View File

@ -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
<code>BPrivate::Network</code> namespace, the header files are found at
<code>headers\\private\\netservices</code>, and you have to link your
application to <code>libnetservices.a</code>.
*/
///// Namespace Documentation /////
//! \brief Internal or experimental API
namespace BPrivate {
/*!
\brief Experimental Network Services API
See \ref netservices for more information.
*/
namespace Network {
}
}

12
docs/user/shared/Geolocation.dox → docs/user/netservices/Geolocation.dox
View File

@ -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.

10
docs/user/net/HttpAuthentication.dox → docs/user/netservices/HttpAuthentication.dox
View File

@ -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

28
docs/user/net/HttpForm.dox → docs/user/netservices/HttpForm.dox
View File

@ -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.
*/

14
docs/user/net/HttpHeaders.dox → docs/user/netservices/HttpHeaders.dox
View File

@ -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

10
docs/user/net/HttpRequest.dox → docs/user/netservices/HttpRequest.dox
View File

@ -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

10
docs/user/net/UrlProtocolAsynchronousListener.dox → docs/user/netservices/UrlProtocolAsynchronousListener.dox
View File

@ -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

16
docs/user/net/UrlProtocolListener.dox → docs/user/netservices/UrlProtocolListener.dox
View File

@ -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.

10
docs/user/net/UrlProtocolRoster.dox → docs/user/netservices/UrlProtocolRoster.dox
View File

@ -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.
*/