HaikuBook: housekeeping of the netservices documentation

Change-Id: I6f9444665e061047bfb024ac0274b69fa1396912

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

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
+	<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 {
+
+	}
+}

docs/user/netservices/Geolocation.dox

@@ -6,21 +6,21 @@
  *		Adrien Destugues, [email protected]
  *
  * Corresponds to:
- *		headers/private/shared/Geolocation.h	hrev53611
+ *		headers/private/netservices/Geolocation.h		hrev54923
- *		src/kits/shared/Geolocation.cpp			hrev53613S
+ *		src/kits/network/libnetservices/Geolocation.cpp	hrev54923
  */
 
 
 /*!
 	\file Geolocation.h
-	\ingroup shared
+	\ingroup netservices
 	\brief Geolocation and geocoding services.
 */
 
 
 /*!
-	\class BGeolocation
+	\class BPrivate::Network::BGeolocation
-	\ingroup shared
+	\ingroup netservices
 	\brief Geolocation and geocoding services.
 
 	Geolocation allows to know where the computer is currently located.

docs/user/netservices/HttpAuthentication.dox

@@ -6,19 +6,19 @@
  *		Adrien Destugues, [email protected]
  *
  * Corresponds to:
- *		headers/os/net/HttpAuthentication.h rev 39161
+ *		headers/private/netservices/HttpAuthentication.h		hrev54923
- *		src/kits/network/libnetapi/HttpAuthentication.cpp rev 45363
+ *		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
+	\class BPrivate::Network::BHttpAuthentication
-	\ingroup network
+	\ingroup netservices
 	\brief Authentication token for the HTTP protocol.
 
 	This class allows managing of an authenticated http session. It stores the

docs/user/netservices/HttpForm.dox

@@ -7,21 +7,21 @@
  *		John Scipione, [email protected]
  *
  * Corresponds to:
- *		headers/os/net/HttpForm.h hrev46314
+ *		headers/private/netservices/HttpForm.h			hrev54923
- *		src/kits/network/libnetapi/HttpForm.cpp hrev46314
+ *		src/kits/network/libnetservices/HttpForm.cpp	hrev54923
  */
 
 
 /*!
 	\file HttpForm.h
-	\ingroup network
+	\ingroup netservices
 	\brief Management of HTTP form data
 */
 
 
 /*!
-	\enum form_type
+	\enum BPrivate::Network::form_type
-	\ingroup network
+	\ingroup netservices
 */
 
 
@@ -36,8 +36,8 @@
 
 
 /*!
-	\enum form_content_type
+	\enum BPrivate::Network::form_content_type
-	\ingroup network
+	\ingroup netservices
 */
 
 
@@ -62,8 +62,8 @@
 
 
 /*!
-	\class BHttpFormData
+	\class BPrivate::Network::BHttpFormData
-	\ingroup network
+	\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
+	\class BPrivate::Network::BHttpForm
-	\ingroup network
+	\ingroup netservices
 	\brief Container for all the BHttpFormData instances making up an HTTP form contents.
 */
 
@@ -361,8 +361,8 @@
 
 
 /*!
-	\class BHttpForm::Iterator
+	\class BPrivate::Network::BHttpForm::Iterator
-	\ingroup network
+	\ingroup netservices
 	\brief Form Iterator.
 */
 

docs/user/netservices/HttpHeaders.dox

@@ -6,19 +6,19 @@
  *		Adrien Destugues, [email protected]
  *
  * Corresponds to:
- *		headers/os/net/HttpHeaders.h rev 39161
+ *		headers/private/netservices/HttpHeaders.h		hrev54923
- *		src/kits/network/libnetapi/HttpHeaders.cpp rev 45253
+ *		src/kits/network/libnetservices/HttpHeaders.cpp	hrev54923
  */
 
 /*!
 	\file HttpHeaders.h
-	\ingroup network
+	\ingroup netservices
 	\brief Management of HTTP headers
 */
 
 /*!
-	\class BHttpHeader
+	\class BPrivate::Network::BHttpHeader
-	\ingroup network
+	\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
+	\class BPrivate::Network::BHttpHeaders
-	\ingroup network
+	\ingroup netservices
 	\brief Container for a set of HTTP headers.
 
 	This class allows management of the set of headers for a single HTTP

docs/user/netservices/HttpRequest.dox

@@ -7,21 +7,21 @@
  *		John Scipione, [email protected]
  *
  * Corresponds to:
- *		headers/os/net/HttpRequest.h hrev46314
+ *		headers/private/netservices/HttpRequest.h		hrev54923
- *		src/kits/network/libnetapi/HttpRequest.cpp hrev46314
+ *		src/kits/network/libnetservices/HttpRequest.cpp	hrev54923
  */
 
 
 /*!
 	\file HttpRequest.h
-	\ingroup network
+	\ingroup netservices
 	\brief Management of HTTP or HTTPS protocol requests
 */
 
 
 /*!
-	\class BHttpRequest
+	\class BPrivate::Network::BHttpRequest
-	\ingroup network
+	\ingroup netservices
 	\brief Handles a request over HTTP or HTTPS.
 
 	Instances of ths class will be created by the BUrlProtocolRoster for

docs/user/netservices/UrlProtocolAsynchronousListener.dox

@@ -6,21 +6,21 @@
  *		Leorize, [email protected]
  *
  * Corresponds to:
- *		headers/os/net/UrlProtocolAsynchronousListener.h hrev54280
+ *		headers/private/netservices/UrlProtocolAsynchronousListener.h	hrev54923
- *		src/kits/network/libnetapi/UrlProtocolAsynchronousListener.cpp hrev54280
+ *		src/kits/network/libnetapi/UrlProtocolAsynchronousListener.cpp	hrev54923
  */
 
 
 /*!
 	\file UrlProtocolAsynchronousListener.h
-	\ingroup network
+	\ingroup netservices
 	\brief Provides the BUrlProtocolAsynchronousListener interface.
 */
 
 
 /*!
-	\class BUrlProtocolAsynchronousListener
+	\class BPrivate::Network::BUrlProtocolAsynchronousListener
-	\ingroup network
+	\ingroup netservices
 	\brief Provides a handler for BUrlProtocolDispatchingListener.
 
 	BUrlProtocolAsynchronousListener transparently handles BMessage issued by

docs/user/netservices/UrlProtocolListener.dox

@@ -6,20 +6,20 @@
  *		Leorize, [email protected]
  *
  * Corresponds to:
- *		headers/os/net/UrlProtocolListener.h hrev54280
+ *		headers/private/netservices/UrlProtocolListener.h	hrev54923
- *		src/kits/network/libnetapi/UrlProtocolListener.cpp hrev54280
+ *		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
+	\class BPrivate::Network::BUrlProtocolListener
-	\ingroup network
+	\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.

docs/user/netservices/UrlProtocolRoster.dox

@@ -6,21 +6,21 @@
  *		Leorize, [email protected]
  *
  * Corresponds to:
- *		headers/os/net/UrlProtocolRoster.h hrev54280
+ *		headers/private/netservices/UrlProtocolRoster.h			hrev54923
- *		src/kits/network/libnetapi/UrlProtocolRoster.cpp hrev54280
+ *		src/kits/network/libnetservices/UrlProtocolRoster.cpp	hrev54923
  */
 
 
 /*!
 	\file UrlProtocolRoster.h
-	\ingroup network
+	\ingroup netservices
 	\brief Provides the BUrlProtocolRoster interface.
 */
 
 
 /*!
-	\class BUrlProtocolRoster
+	\class BPrivate::Network::BUrlProtocolRoster
-	\ingroup network
+	\ingroup netservices
 	\brief Interfaces for protocol-agnostic operations.
 */