diff options
author | Luca Di Sera <luca.disera@qt.io> | 2021-09-15 16:41:31 +0200 |
---|---|---|
committer | Luca Di Sera <luca.disera@qt.io> | 2021-09-16 15:52:27 +0200 |
commit | 10eedd175e99a8be191d116d5c81c340d6c3c5b6 (patch) | |
tree | 5d9feef6004d00495fc7960b2a038ebd785856ab /src/corelib/serialization/qcborstreamwriter.cpp | |
parent | 0246bfd40a2cc5ea9cfc035146e6dd865b334c68 (diff) |
Doc: Centralize RFC documentation-links in rfc.qdoc
In the effort of repairing broken links as per QTBUG-96127,
a series of RFC links referring to `tools.ietf.org/html/*` were modified
to point to the new address that the site redirected to.
To simplify executing a similar task and to diminish the duplication of
manually inserted urls, the already existing `rfc.qdoc` file, containing
`\externalpage` commands directing to RFC locations, was enhanced with
links to all RFCs that were mentioned in the current documentation, so
as to aggregate this common category of links.
All links pointing to a `ietf` domain inside QDoc documentation blocks
were then changed to use the newly provided external-references.
Task-number: QTBUG-96127
Pick-to: 6.2
Change-Id: I2a52eb6aa8c9e346f64ef1a627b039220d9f6c2a
Reviewed-by: MÃ¥rten Nordheim <marten.nordheim@qt.io>
Diffstat (limited to 'src/corelib/serialization/qcborstreamwriter.cpp')
-rw-r--r-- | src/corelib/serialization/qcborstreamwriter.cpp | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/src/corelib/serialization/qcborstreamwriter.cpp b/src/corelib/serialization/qcborstreamwriter.cpp index ff6cbbec00..d3c0066cca 100644 --- a/src/corelib/serialization/qcborstreamwriter.cpp +++ b/src/corelib/serialization/qcborstreamwriter.cpp @@ -92,8 +92,7 @@ Q_DECLARE_TYPEINFO(CborEncoder, Q_PRIMITIVE_TYPE); Representation, a very compact form of binary data encoding that is compatible with JSON. It was created by the IETF Constrained RESTful Environments (CoRE) WG, which has used it in many new RFCs. It is meant to - be used alongside the \l{https://tools.ietf.org/html/rfc7252}{CoAP - protocol}. + be used alongside the \l{RFC 7252}{CoAP protocol}. QCborStreamWriter provides a StAX-like API, similar to that of \l{QXmlStreamWriter}. It is rather low-level and requires a bit of knowledge @@ -123,7 +122,7 @@ Q_DECLARE_TYPEINFO(CborEncoder, Q_PRIMITIVE_TYPE); QCborStreamWriter supports all CBOR features required to create canonical and strict streams. It implements almost all of the features specified in - \l {https://tools.ietf.org/html/rfc7049}{RFC 7049}. + \l {RFC 7049}. The following table lists the CBOR features that QCborStreamWriter supports. @@ -151,7 +150,7 @@ Q_DECLARE_TYPEINFO(CborEncoder, Q_PRIMITIVE_TYPE); \section2 Canonical CBOR encoding Canonical CBOR encoding is defined by - \l{https://tools.ietf.org/html/rfc7049#section-3.9}{Section 3.9 of RFC + \l{RFC 7049, section 3.9}{Section 3.9 of RFC 7049}. Canonical encoding is not a requirement for Qt's CBOR decoding functionality, but it may be required for some protocols. In particular, protocols that require the ability to reproduce the same stream identically @@ -181,7 +180,7 @@ Q_DECLARE_TYPEINFO(CborEncoder, Q_PRIMITIVE_TYPE); \section2 Strict CBOR mode Strict mode is defined by - \l{https://tools.ietf.org/html/rfc7049#section-3.10}{Section 3.10 of RFC + \l{RFC 7049, section 3.10}{Section 3.10 of RFC 7049}. As for Canonical encoding above, QCborStreamWriter makes it possible to create strict CBOR streams, but does not require them or validate that the output is so. |