From fcf08bbd68aef788d6359c896f6bdc11fc98f1cb Mon Sep 17 00:00:00 2001 From: Leorize Date: Thu, 18 Jun 2020 00:07:20 -0500 Subject: [PATCH] docs: Add documentation for BUrlProtocolRoster Change-Id: Id4bc0809c970ea14f814820b54e52073e3396502 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2928 Reviewed-by: waddlesplash --- docs/user/net/UrlProtocolRoster.dox | 42 +++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/user/net/UrlProtocolRoster.dox diff --git a/docs/user/net/UrlProtocolRoster.dox b/docs/user/net/UrlProtocolRoster.dox new file mode 100644 index 0000000000..c17944019e --- /dev/null +++ b/docs/user/net/UrlProtocolRoster.dox @@ -0,0 +1,42 @@ +/* + * Copyright 2020 Haiku, Inc. All rights reserved. + * Distributed under the terms of the MIT License. + * + * Authors: + * Leorize, leorize+oss@disroot.org + * + * Corresponds to: + * headers/os/net/UrlProtocolRoster.h hrev54280 + * src/kits/network/libnetapi/UrlProtocolRoster.cpp hrev54280 + */ + + +/*! + \file UrlProtocolRoster.h + \ingroup network + \brief Provides the BUrlProtocolRoster interface. +*/ + + +/*! + \class BUrlProtocolRoster + \ingroup network + \brief Interfaces for protocol-agnostic operations. +*/ + + +/*! + \fn static BUrlRequest* BUrlProtocolRoster::MakeRequest(const BUrl& url, + BUrlProtocolListener* listener = NULL, BUrlContext* context = NULL) + \brief Create a BUrlRequest that can handle the given BUrl + + \param url The URL to create a request for + \param listener The BUrlProtocolListener to be registered with the created + BUrlRequest, can be \c NULL + \param context The BUrlContext to be registered with the created + BUrlRequest, can be \c NULL + + \returns A pointer to the BUrlRequest that can handle the given BUrl. + \c NULL will be returned if there aren't any BUrlRequest that can + handle the given protocol or if memory couldn't be allocated. +*/