Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-10-20 08:45:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1609943 - Merged two mentions of naming nsresult error variables, and improved wording a bit. r=sylvestre

Browse Source 
Depends on D60273

Differential Revision: https://phabricator.services.mozilla.com/D60281

--HG--
extra : moz-landing-system : lando
This commit is contained in:
Simon Giesecke 2020-01-18 12:04:36 +00:00
parent 3da8e73cda
commit 3e22e77cc5
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
tools/lint/docs/coding-style/coding_style_cpp.rst
View File

@ -299,9 +299,10 @@ Global functions/macros/etc
Error Variables
^^^^^^^^^^^^^^^
- local nsresult result codes should be named ``rv``. `rv` should not be
- Local variables that are assigned ``nsresult`` result codes should be named ``rv``
(i.e., e.g., not ``res``, not ``result``, not ``foo``). `rv` should not be
used for bool or other result types.
- local bool result codes should be named `ok`
- Local variables that are assigned ``bool`` result codes should be named `ok`.
C/C++ practices
@ -372,8 +373,6 @@ COM and pointers
`nsWeakPtr <https://developer.mozilla.org/docs/Mozilla/Tech/XPCOM/Weak_reference>`__ for weak references.
- Don't use ``QueryInterface`` directly. Use ``CallQueryInterface`` or
``do_QueryInterface`` instead.
- ``nsresult`` should be declared as ``rv``. Not ``res``, not ``result``, not
``foo``.
- Use `Contract
IDs <news://news.mozilla.org/3994AE3E.D96EF810@netscape.com>`__,
instead of CIDs with ``do_CreateInstance``/``do_GetService``.