From 95d83cb1b68cc4a415d5d80859b4e74472ad7112 Mon Sep 17 00:00:00 2001 From: Casper van Donderen Date: Thu, 1 Mar 2012 15:28:31 +0100 Subject: Remove the usage of deprecated qdoc macros. QDoc now has support for Doxygen style commands for italics, bold and list items. This change applies that change in QDoc to the actual documentation. Task-number: QTBUG-24578 Change-Id: I519bf9c29b14092e3ab6067612f42bf749eeedf5 Reviewed-by: Shane Kearns Reviewed-by: Lars Knoll --- src/network/access/qnetworkaccessmanager.cpp | 8 ++-- src/network/bearer/qnetworkconfiguration.cpp | 42 +++++++++--------- src/network/bearer/qnetworksession.cpp | 18 ++++---- src/network/kernel/qauthenticator.cpp | 14 +++--- src/network/kernel/qhostaddress.cpp | 14 +++--- src/network/kernel/qnetworkproxy.cpp | 66 ++++++++++++++-------------- src/network/kernel/qnetworkproxy_mac.cpp | 16 +++---- src/network/socket/qabstractsocket.cpp | 34 +++++++------- src/network/socket/qtcpsocket.cpp | 2 +- src/network/ssl/qsslcertificateextension.cpp | 54 +++++++++++------------ src/network/ssl/qsslconfiguration.cpp | 20 ++++----- src/network/ssl/qsslsocket.cpp | 10 ++--- 12 files changed, 149 insertions(+), 149 deletions(-) (limited to 'src/network') diff --git a/src/network/access/qnetworkaccessmanager.cpp b/src/network/access/qnetworkaccessmanager.cpp index 740e54b833..60c28274c6 100644 --- a/src/network/access/qnetworkaccessmanager.cpp +++ b/src/network/access/qnetworkaccessmanager.cpp @@ -451,12 +451,12 @@ QNetworkProxyFactory *QNetworkAccessManager::proxyFactory() const For example, a proxy factory could apply the following rules: \list - \o if the target address is in the local network (for example, + \li if the target address is in the local network (for example, if the hostname contains no dots or if it's an IP address in the organization's range), return QNetworkProxy::NoProxy - \o if the request is FTP, return an FTP proxy - \o if the request is HTTP or HTTPS, then return an HTTP proxy - \o otherwise, return a SOCKSv5 proxy server + \li if the request is FTP, return an FTP proxy + \li if the request is HTTP or HTTPS, then return an HTTP proxy + \li otherwise, return a SOCKSv5 proxy server \endlist The lifetime of the object \a factory will be managed by diff --git a/src/network/bearer/qnetworkconfiguration.cpp b/src/network/bearer/qnetworkconfiguration.cpp index 037a7fdbf3..0aa843f393 100644 --- a/src/network/bearer/qnetworkconfiguration.cpp +++ b/src/network/bearer/qnetworkconfiguration.cpp @@ -424,37 +424,37 @@ QNetworkConfiguration::BearerType QNetworkConfiguration::bearerType() const \table \header - \o BearerType - \o Value + \li BearerType + \li Value \row - \o BearerUnknown - \o - \o The session is based on an unknown or unspecified bearer type. The value of the + \li BearerUnknown + \li + \li The session is based on an unknown or unspecified bearer type. The value of the string returned describes the bearer type. \row - \o BearerEthernet - \o Ethernet + \li BearerEthernet + \li Ethernet \row - \o BearerWLAN - \o WLAN + \li BearerWLAN + \li WLAN \row - \o Bearer2G - \o 2G + \li Bearer2G + \li 2G \row - \o BearerCDMA2000 - \o CDMA2000 + \li BearerCDMA2000 + \li CDMA2000 \row - \o BearerWCDMA - \o WCDMA + \li BearerWCDMA + \li WCDMA \row - \o BearerHSPA - \o HSPA + \li BearerHSPA + \li HSPA \row - \o BearerBluetooth - \o Bluetooth + \li BearerBluetooth + \li Bluetooth \row - \o BearerWiMAX - \o WiMAX + \li BearerWiMAX + \li WiMAX \endtable This function returns an empty string if this is an invalid configuration, a network diff --git a/src/network/bearer/qnetworksession.cpp b/src/network/bearer/qnetworksession.cpp index 3f8cabe26e..ccf794633d 100644 --- a/src/network/bearer/qnetworksession.cpp +++ b/src/network/bearer/qnetworksession.cpp @@ -455,10 +455,10 @@ QString QNetworkSession::errorString() const \table \header - \o Key \o Description + \li Key \li Description \row - \o ActiveConfiguration - \o If the session \l isOpen() this property returns the identifier of the + \li ActiveConfiguration + \li If the session \l isOpen() this property returns the identifier of the QNetworkConfiguration that is used by this session; otherwise an empty string. The main purpose of this key is to determine which Internet access point is used @@ -479,8 +479,8 @@ QString QNetworkSession::errorString() const } \endcode \row - \o UserChoiceConfiguration - \o If the session \l isOpen() and is bound to a QNetworkConfiguration of type + \li UserChoiceConfiguration + \li If the session \l isOpen() and is bound to a QNetworkConfiguration of type UserChoice, this property returns the identifier of the QNetworkConfiguration that the configuration resolved to when \l open() was called; otherwise an empty string. @@ -492,14 +492,14 @@ QString QNetworkSession::errorString() const whereas \e ActiveConfiguration always returns identifiers to \l {QNetworkConfiguration::InternetAccessPoint}{Internet access points} configurations. \row - \o ConnectInBackground - \o Setting this property to \e true before calling \l open() implies that the connection attempt + \li ConnectInBackground + \li Setting this property to \e true before calling \l open() implies that the connection attempt is made but if no connection can be established, the user is not connsulted and asked to select a suitable connection. This property is not set by default and support for it depends on the platform. \row - \o AutoCloseSessionTimeout - \o If the session requires polling to keep its state up to date, this property holds + \li AutoCloseSessionTimeout + \li If the session requires polling to keep its state up to date, this property holds the timeout in milliseconds before the session will automatically close. If the value of this property is -1 the session will not automatically close. This property is set to -1 by default. diff --git a/src/network/kernel/qauthenticator.cpp b/src/network/kernel/qauthenticator.cpp index b14fbf8c30..eef2a7fa76 100644 --- a/src/network/kernel/qauthenticator.cpp +++ b/src/network/kernel/qauthenticator.cpp @@ -80,9 +80,9 @@ static QByteArray qNtlmPhase3(QAuthenticatorPrivate *ctx, const QByteArray& phas QAuthenticator supports the following authentication methods: \list - \o Basic - \o NTLM version 2 - \o Digest-MD5 + \li Basic + \li NTLM version 2 + \li Digest-MD5 \endlist \section1 Options @@ -104,8 +104,8 @@ static QByteArray qNtlmPhase3(QAuthenticatorPrivate *ctx, const QByteArray& phas \section2 Basic \table - \header \o Option \o Direction \o Description - \row \o \tt{realm} \o Incoming \o Contains the realm of the authentication, the same as realm() + \header \li Option \li Direction \li Description + \row \li \tt{realm} \li Incoming \li Contains the realm of the authentication, the same as realm() \endtable The Basic authentication mechanism supports no outgoing options. @@ -117,8 +117,8 @@ static QByteArray qNtlmPhase3(QAuthenticatorPrivate *ctx, const QByteArray& phas \section2 Digest-MD5 \table - \header \o Option \o Direction \o Description - \row \o \tt{realm} \o Incoming \o Contains the realm of the authentication, the same as realm() + \header \li Option \li Direction \li Description + \row \li \tt{realm} \li Incoming \li Contains the realm of the authentication, the same as realm() \endtable The Digest-MD5 authentication mechanism supports no outgoing options. diff --git a/src/network/kernel/qhostaddress.cpp b/src/network/kernel/qhostaddress.cpp index dd46b8126b..230abb86aa 100644 --- a/src/network/kernel/qhostaddress.cpp +++ b/src/network/kernel/qhostaddress.cpp @@ -822,20 +822,20 @@ QString QHostAddress::toString() const \list - \o Node-local: Addresses that are only used for communicating with + \li Node-local: Addresses that are only used for communicating with services on the same interface (e.g., the loopback interface "::1"). - \o Link-local: Addresses that are local to the network interface + \li Link-local: Addresses that are local to the network interface (\e{link}). There is always one link-local address for each IPv6 interface on your host. Link-local addresses ("fe80...") are generated from the MAC address of the local network adaptor, and are not guaranteed to be unique. - \o Site-local: Addresses that are local to the site / private network + \li Site-local: Addresses that are local to the site / private network (e.g., the company intranet). Site-local addresses ("fec0...") are usually distributed by the site router, and are not guaranteed to be unique outside of the local site. - \o Global: For globally routable addresses, such as public servers on the + \li Global: For globally routable addresses, such as public servers on the Internet. \endlist @@ -1001,9 +1001,9 @@ bool QHostAddress::isInSubnet(const QPair &subnet) const This function supports arguments in the form: \list - \o 123.123.123.123/n where n is any value between 0 and 32 - \o 123.123.123.123/255.255.255.255 - \o /n where n is any value between 0 and 128 + \li 123.123.123.123/n where n is any value between 0 and 32 + \li 123.123.123.123/255.255.255.255 + \li /n where n is any value between 0 and 128 \endlist For IP version 4, this function accepts as well missing trailing diff --git a/src/network/kernel/qnetworkproxy.cpp b/src/network/kernel/qnetworkproxy.cpp index 0238d22eb6..0281eaf48b 100644 --- a/src/network/kernel/qnetworkproxy.cpp +++ b/src/network/kernel/qnetworkproxy.cpp @@ -139,35 +139,35 @@ \table \header - \o Proxy type - \o Description - \o Default capabilities + \li Proxy type + \li Description + \li Default capabilities \row - \o SOCKS 5 - \o Generic proxy for any kind of connection. Supports TCP, + \li SOCKS 5 + \li Generic proxy for any kind of connection. Supports TCP, UDP, binding to a port (incoming connections) and authentication. - \o TunnelingCapability, ListeningCapability, + \li TunnelingCapability, ListeningCapability, UdpTunnelingCapability, HostNameLookupCapability \row - \o HTTP - \o Implemented using the "CONNECT" command, supports only + \li HTTP + \li Implemented using the "CONNECT" command, supports only outgoing TCP connections; supports authentication. - \o TunnelingCapability, CachingCapability, HostNameLookupCapability + \li TunnelingCapability, CachingCapability, HostNameLookupCapability \row - \o Caching-only HTTP - \o Implemented using normal HTTP commands, it is useful only + \li Caching-only HTTP + \li Implemented using normal HTTP commands, it is useful only in the context of HTTP requests (see QNetworkAccessManager) - \o CachingCapability, HostNameLookupCapability + \li CachingCapability, HostNameLookupCapability \row - \o Caching FTP - \o Implemented using an FTP proxy, it is useful only in the + \li Caching FTP + \li Implemented using an FTP proxy, it is useful only in the context of FTP requests (see QNetworkAccessManager) - \o CachingCapability, HostNameLookupCapability + \li CachingCapability, HostNameLookupCapability \endtable @@ -856,12 +856,12 @@ template<> void QSharedDataPointer::detach() the proxy: \list - \o the type of query - \o the local port number to use - \o the destination host name - \o the destination port number - \o the protocol name, such as "http" or "ftp" - \o the URL being requested + \li the type of query + \li the local port number to use + \li the destination host name + \li the destination port number + \li the protocol name, such as "http" or "ftp" + \li the URL being requested \endlist The destination host name is the host in the connection in the @@ -895,35 +895,35 @@ template<> void QSharedDataPointer::detach() \table \header - \o Query type - \o Description + \li Query type + \li Description \row - \o TcpSocket - \o Normal sockets requesting a connection to a remote server, + \li TcpSocket + \li Normal sockets requesting a connection to a remote server, like QTcpSocket. The peer hostname and peer port match the values passed to QTcpSocket::connectToHost(). The local port is usually -1, indicating the socket has no preference in which port should be used. The URL component is not used. \row - \o UdpSocket - \o Datagram-based sockets, which can both send and + \li UdpSocket + \li Datagram-based sockets, which can both send and receive. The local port, remote host or remote port fields can all be used or be left unused, depending on the characteristics of the socket. The URL component is not used. \row - \o TcpServer - \o Passive server sockets that listen on a port and await + \li TcpServer + \li Passive server sockets that listen on a port and await incoming connections from the network. Normally, only the local port is used, but the remote address could be used in specific circumstances, for example to indicate which remote host a connection is expected from. The URL component is not used. \row - \o UrlRequest - \o A more high-level request, such as those coming from + \li UrlRequest + \li A more high-level request, such as those coming from QNetworkAccessManager. These requests will inevitably use an outgoing TCP socket, but the this query type is provided to indicate that more detailed information is present in the URL @@ -1487,10 +1487,10 @@ void QNetworkProxyFactory::setApplicationProxyFactory(QNetworkProxyFactory *fact listed here. \list - \o On MacOS X, this function will ignore the Proxy Auto Configuration + \li On MacOS X, this function will ignore the Proxy Auto Configuration settings, since it cannot execute the associated ECMAScript code. - \o On Windows platforms, this function may take several seconds to + \li On Windows platforms, this function may take several seconds to execute depending on the configuration of the user's system. \endlist */ diff --git a/src/network/kernel/qnetworkproxy_mac.cpp b/src/network/kernel/qnetworkproxy_mac.cpp index 75ed17048c..d25917ee47 100644 --- a/src/network/kernel/qnetworkproxy_mac.cpp +++ b/src/network/kernel/qnetworkproxy_mac.cpp @@ -58,14 +58,14 @@ * proxy settings for: * * \list - * \o FTP proxy - * \o Web Proxy (HTTP) - * \o Secure Web Proxy (HTTPS) - * \o Streaming Proxy (RTSP) - * \o SOCKS Proxy - * \o Gopher Proxy - * \o URL for Automatic Proxy Configuration (PAC scripts) - * \o Bypass list (by default: *.local, 169.254/16) + * \li FTP proxy + * \li Web Proxy (HTTP) + * \li Secure Web Proxy (HTTPS) + * \li Streaming Proxy (RTSP) + * \li SOCKS Proxy + * \li Gopher Proxy + * \li URL for Automatic Proxy Configuration (PAC scripts) + * \li Bypass list (by default: *.local, 169.254/16) * \endlist * * The matching configuration can be obtained by calling SCDynamicStoreCopyProxies diff --git a/src/network/socket/qabstractsocket.cpp b/src/network/socket/qabstractsocket.cpp index 75e99fe223..2f66671530 100644 --- a/src/network/socket/qabstractsocket.cpp +++ b/src/network/socket/qabstractsocket.cpp @@ -56,8 +56,8 @@ you need a socket, you have two options: \list - \i Instantiate QTcpSocket or QUdpSocket. - \i Create a native socket descriptor, instantiate + \li Instantiate QTcpSocket or QUdpSocket. + \li Create a native socket descriptor, instantiate QAbstractSocket, and call setSocketDescriptor() to wrap the native socket. \endlist @@ -129,15 +129,15 @@ can be used to implement blocking sockets: \list - \o waitForConnected() blocks until a connection has been established. + \li waitForConnected() blocks until a connection has been established. - \o waitForReadyRead() blocks until new data is available for + \li waitForReadyRead() blocks until new data is available for reading. - \o waitForBytesWritten() blocks until one payload of data has been + \li waitForBytesWritten() blocks until one payload of data has been written to the socket. - \o waitForDisconnected() blocks until the connection has closed. + \li waitForDisconnected() blocks until the connection has closed. \endlist We show an example: @@ -377,15 +377,15 @@ Possible values for the \e{TypeOfServiceOption} are: \table - \header \o Value \o Description - \row \o 224 \o Network control - \row \o 192 \o Internetwork control - \row \o 160 \o CRITIC/ECP - \row \o 128 \o Flash override - \row \o 96 \o Flash - \row \o 64 \o Immediate - \row \o 32 \o Priority - \row \o 0 \o Routine + \header \li Value \li Description + \row \li 224 \li Network control + \row \li 192 \li Internetwork control + \row \li 160 \li CRITIC/ECP + \row \li 128 \li Flash override + \row \li 96 \li Flash + \row \li 64 \li Immediate + \row \li 32 \li Priority + \row \li 0 \li Routine \endtable \sa QAbstractSocket::setSocketOption(), QAbstractSocket::socketOption() @@ -1510,7 +1510,7 @@ bool QAbstractSocket::bind(quint16 port, BindMode mode) Returns true if the socket is valid and ready for use; otherwise returns false. - \bold{Note:} The socket's state must be ConnectedState before reading and + \b{Note:} The socket's state must be ConnectedState before reading and writing can occur. \sa state() @@ -1792,7 +1792,7 @@ qintptr QAbstractSocket::socketDescriptor() const The socket is opened in the mode specified by \a openMode, and enters the socket state specified by \a socketState. - \bold{Note:} It is not possible to initialize two abstract sockets + \b{Note:} It is not possible to initialize two abstract sockets with the same native socket descriptor. \sa socketDescriptor() diff --git a/src/network/socket/qtcpsocket.cpp b/src/network/socket/qtcpsocket.cpp index 706f5721b2..dff8b5efb5 100644 --- a/src/network/socket/qtcpsocket.cpp +++ b/src/network/socket/qtcpsocket.cpp @@ -58,7 +58,7 @@ allows you to establish a TCP connection and transfer streams of data. See the QAbstractSocket documentation for details. - \bold{Note:} TCP sockets cannot be opened in QIODevice::Unbuffered mode. + \b{Note:} TCP sockets cannot be opened in QIODevice::Unbuffered mode. \sa QTcpServer, QUdpSocket, QNetworkAccessManager, {Fortune Server Example}, {Fortune Client Example}, diff --git a/src/network/ssl/qsslcertificateextension.cpp b/src/network/ssl/qsslcertificateextension.cpp index eef27d7c2e..89b1a929c8 100644 --- a/src/network/ssl/qsslcertificateextension.cpp +++ b/src/network/ssl/qsslcertificateextension.cpp @@ -58,26 +58,26 @@ \table \header - \o Property - \o Description + \li Property + \li Description \row - \o name - \o The human readable name of the extension, eg. 'basicConstraints'. + \li name + \li The human readable name of the extension, eg. 'basicConstraints'. \row - \o criticality - \o This is a boolean value indicating if the extension is critical + \li criticality + \li This is a boolean value indicating if the extension is critical to correctly interpreting the certificate. \row - \o oid - \o The ASN.1 object identifier that specifies which extension this + \li oid + \li The ASN.1 object identifier that specifies which extension this is. \row - \o supported - \o If this is true the structure of the extension's value will not + \li supported + \li If this is true the structure of the extension's value will not change between Qt versions. \row - \o value - \o A QVariant with a structure dependent on the type of extension. + \li value + \li A QVariant with a structure dependent on the type of extension. \endtable Whilst this class provides access to any type of extension, only @@ -90,28 +90,28 @@ \table \header - \o Name - \o OID - \o Details + \li Name + \li OID + \li Details \row - \o basicConstraints - \o 2.5.29.19 - \o Returned as a QVariantMap. The key 'ca' contains a boolean value, + \li basicConstraints + \li 2.5.29.19 + \li Returned as a QVariantMap. The key 'ca' contains a boolean value, the optional key 'pathLenConstraint' contains an integer. \row - \o authorityInfoAccess - \o 1.3.6.1.5.5.7.1.1 - \o Returned as a QVariantMap. There is a key for each access method, + \li authorityInfoAccess + \li 1.3.6.1.5.5.7.1.1 + \li Returned as a QVariantMap. There is a key for each access method, with the value being a URI. \row - \o subjectKeyIdentifier - \o 2.5.29.14 - \o Returned as a QVariant containing a QString. The string is the key + \li subjectKeyIdentifier + \li 2.5.29.14 + \li Returned as a QVariant containing a QString. The string is the key identifier. \row - \o authorityKeyIdentifier - \o 2.5.29.35 - \o Returned as a QVariantMap. The optional key 'keyid' contains the key + \li authorityKeyIdentifier + \li 2.5.29.35 + \li Returned as a QVariantMap. The optional key 'keyid' contains the key identifier as a hex string stored in a QByteArray. The optional key 'serial' contains the authority key serial number as a qlonglong. Currently there is no support for the general names field of this diff --git a/src/network/ssl/qsslconfiguration.cpp b/src/network/ssl/qsslconfiguration.cpp index dc530dae88..ec49c0f56e 100644 --- a/src/network/ssl/qsslconfiguration.cpp +++ b/src/network/ssl/qsslconfiguration.cpp @@ -67,11 +67,11 @@ const QSsl::SslOptions QSslConfigurationPrivate::defaultSslOptions = QSsl::SslOp The settings that QSslConfiguration currently supports are: \list - \o The SSL/TLS protocol to be used - \o The certificate to be presented to the peer during connection + \li The SSL/TLS protocol to be used + \li The certificate to be presented to the peer during connection and its associated private key - \o The ciphers allowed to be used for encrypting the connection - \o The list of Certificate Authorities certificates that are + \li The ciphers allowed to be used for encrypting the connection + \li The list of Certificate Authorities certificates that are used to validate the peer's certificate \endlist @@ -81,9 +81,9 @@ const QSsl::SslOptions QSslConfigurationPrivate::defaultSslOptions = QSsl::SslOp The state that QSslConfiguration supports are: \list - \o The certificate the peer presented during handshake, along + \li The certificate the peer presented during handshake, along with the chain leading to a CA certificate - \o The cipher used to encrypt this session + \li The cipher used to encrypt this session \endlist The state can only be obtained once the SSL connection starts, but @@ -541,10 +541,10 @@ bool QSslConfiguration::testSslOption(QSsl::SslOption option) const The default SSL configuration consists of: \list - \o no local certificate and no private key - \o protocol SecureProtocols (meaning either TLS 1.0 or SSL 3 will be used) - \o the system's default CA certificate list - \o the cipher list equal to the list of the SSL libraries' + \li no local certificate and no private key + \li protocol SecureProtocols (meaning either TLS 1.0 or SSL 3 will be used) + \li the system's default CA certificate list + \li the cipher list equal to the list of the SSL libraries' supported SSL ciphers \endlist diff --git a/src/network/ssl/qsslsocket.cpp b/src/network/ssl/qsslsocket.cpp index 311ac5fe86..6338cbbe6f 100644 --- a/src/network/ssl/qsslsocket.cpp +++ b/src/network/ssl/qsslsocket.cpp @@ -132,12 +132,12 @@ The following features can also be customized: \list - \o The socket's cryptographic cipher suite can be customized before + \li The socket's cryptographic cipher suite can be customized before the handshake phase with setCiphers() and setDefaultCiphers(). - \o The socket's local certificate and private key can be customized + \li The socket's local certificate and private key can be customized before the handshake phase with setLocalCertificate() and setPrivateKey(). - \o The CA certificate database can be extended and customized with + \li The CA certificate database can be extended and customized with addCaCertificate(), addCaCertificates(), setCaCertificates(), addDefaultCaCertificate(), addDefaultCaCertificates(), and setDefaultCaCertificates(). @@ -398,7 +398,7 @@ void QSslSocket::resume() \snippet doc/src/snippets/code/src_network_ssl_qsslsocket.cpp 3 - \bold{Note:} The example above shows that text can be written to + \b{Note:} The example above shows that text can be written to the socket immediately after requesting the encrypted connection, before the encrypted() signal has been emitted. In such cases, the text is queued in the object and written to the socket \e after @@ -468,7 +468,7 @@ void QSslSocket::connectToHostEncrypted(const QString &hostName, quint16 port, The socket is opened in the mode specified by \a openMode, and enters the socket state specified by \a state. - \bold{Note:} It is not possible to initialize two sockets with the same + \b{Note:} It is not possible to initialize two sockets with the same native socket descriptor. \sa socketDescriptor() -- cgit v1.2.3