From: David Wells
Date: Tue, 28 Apr 2015 02:22:41 +0000 (-0400)
Subject: Add a style guideline for "&&", "||", and "!".
X-Git-Tag: v8.3.0-rc1~205^2~1
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d1938fdc7d0116a1d041cfc06351773a36dcd3f7;p=dealii.git
Add a style guideline for "&&", "||", and "!".
---
diff --git a/doc/doxygen/headers/coding_conventions.h b/doc/doxygen/headers/coding_conventions.h
index 981a9c0c5d..cf8d091f3c 100644
--- a/doc/doxygen/headers/coding_conventions.h
+++ b/doc/doxygen/headers/coding_conventions.h
@@ -60,6 +60,10 @@ style guidelines outlined in this page.
functions which clear bits of flags should be named clear_*
.
Example: CellIterator::set_refine_flag().
+ Traditional logical operators should be used instead of their English
+ equivalents (i.e., use &&
, ||
, and !
+ instead of and
, or
, and not
).
+
In the implementation files, after each function, at least three
empty lines are expected to
enable better readability. One empty line occurs in functions to