summaryrefslogtreecommitdiffstats
path: root/examples/corelib/serialization/cbordump/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Update example category namesKai Köhne2023-07-101-1/+1
| | | | | | Pick-to: 6.5 6.6 Change-Id: If4a50c403ed0fb299ac0d9a66f1f606151c55930 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Shrink the CBOR dumper example's imageEdward Welbourne2023-05-151-0/+0
| | | | | | | Apply optipng -o7 -zm9 -strip all to the image to make it more compact. Change-Id: Iebfc1f767759b5beac47bd7efa61d1c655163f03 Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
* Add metadata to serialization examplesEdward Welbourne2023-05-151-0/+1
| | | | | | | | | | | | | | There's no separate category for {de,}serialization, so I've put them in Input/Output; and at least some of them are relevant to transmission over the network, so include that as a tag, so that someone writing a network application that wants to use what they illustrate gets a chance of being lead to it. Pick-to: 6.5 Task-number: QTBUG-111228 Change-Id: Ie9f6dbaf85aed852e9f64eba05ec8c5fe0a7382d Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io> Reviewed-by: Marc Mutz <marc.mutz@qt.io>
* Update cbordump image to a higher-resolution oneEdward Welbourne2023-05-091-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Incidentally using reversed video, too, as that's what came naturally to the terminal I was using. File is smaller, but text in the new image is considerably more readable and the image is bigger. The examples guideline calls for an image giving some idea what the example is about, with a 4:3 or 5:4 aspect ratio. An image shorter than its width wasn't practical, and getting a useful amount of information in a height less than 3/2 of the width would have required widening into blank space purely to satisfy the aspect ratio. The prior image's ratio was about 12:7, the new one's is roughly 2:3. The old image showed the start of cbordump -a output, which is rather less illuminating than the default output of formatted data; it's also rather verbose, so was cut off part way through. It does, however, illustrate how the annotated form might be useful for debug purposes. The image also had a lot of blank space to the right of the text of interest, wasting roughly half of its width; it could easily have been cropped to 1:1 without loss of information. As example data-set, it used ../savegame/save.dat, but without any hint to how to generate that. I decided to include a hint to how to generate a CBOR data file to dump, then show the standard output and only the beginnings of the annotated output, as the latter (even on its own) would make the aspect ratio considerably taller. In the context of the standard display, the preamble of the annotated one gives a reasonable feel for what's going on, without belabouring the point. Pick-to: 6.5 Task-number: QTBUG-111228 Change-Id: Ic54893c483607e95627a50db76a0d9918744c07e Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
* Doc: Add XML, Json, CBOR examples to IO categoryKai Köhne2023-05-091-0/+1
| | | | | | | | Pick-to: 6.5 6.5.1 Task-number: QTBUG-112372 Change-Id: I867bd33ff08629e03b35eccd4b7418573abe7c68 Reviewed-by: Øystein Heskestad <oystein.heskestad@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Rework documentation of cbordump exampleEdward Welbourne2023-03-201-23/+24
| | | | | | | | | | | | | | | Focus the phrasing on what it teaches - how to use the stream reader - more than the example application of that, displaying it. Update docs: * Changed name to conform to modern guidelines. * Consistently mark \c cbodrump as code. * Fix mentions of CborDumper and CborTagDescription to match code. * Say how the tagDescriptions table is used. Pick-to: 6.5 Task-number: QTBUG-111228 Change-Id: Ic12e77cf34caadc9f60527e886f94c76cb8cfeaf Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Add CBOR documentationØystein Heskestad2022-09-012-0/+52
Add documentation of usage of CBOR in convert and cbordump examples, add a CBOR overview, and add links to them other places in the documentation. Task-number: QTBUG-85912 Change-Id: I518792db63647bf9ddd4507d8d4b7ef056192f82 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>