diff options
author | Robin Farine <robin.farine@gmail.com> | 2022-01-23 16:04:03 +0100 |
---|---|---|
committer | Christian Kandeler <christian.kandeler@qt.io> | 2022-01-24 09:52:13 +0000 |
commit | 59f24c1505d0f6b1a48f9b8737b56f76a1d8742b (patch) | |
tree | e2721df4b73010853bd1f283312c8ff1b82776b3 | |
parent | 768b6894a8d189158fed83cbc79d92d5484cb2e4 (diff) | |
download | qbs-59f24c1505d0f6b1a48f9b8737b56f76a1d8742b.tar.gz |
Doc: align JSON API ErrorInfo with code
'ErrorItem::toJson()' maps the key 'description' to the textual description
of the error.
Change-Id: I92c4b7521f6ffbda60196eb1fa363a0a79431f6a
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
-rw-r--r-- | doc/appendix/json-api.qdoc | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/appendix/json-api.qdoc b/doc/appendix/json-api.qdoc index 78e359017..68bb644cf 100644 --- a/doc/appendix/json-api.qdoc +++ b/doc/appendix/json-api.qdoc @@ -765,7 +765,7 @@ \c items is an array of objects with the following structure: \table \header \li Property \li Type \li Mandatory - \row \li \c message \li string \li yes + \row \li description \li string \li yes \row \li location \li \l Location \li no \endtable |