docs: Add documentation for BUrlProtocolRoster
Change-Id: Id4bc0809c970ea14f814820b54e52073e3396502 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2928 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
This commit is contained in:
parent
fbb8bf7ee3
commit
fcf08bbd68
42
docs/user/net/UrlProtocolRoster.dox
Normal file
42
docs/user/net/UrlProtocolRoster.dox
Normal file
@ -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.
|
||||
*/
|
Loading…
Reference in New Issue
Block a user