From 0bb8fa955394d0b9edd51d4d5ebb467053e9addf Mon Sep 17 00:00:00 2001
From: David Wells
Date: Fri, 20 Sep 2019 19:00:40 -0400
Subject: [PATCH] Fix some minor issues with the coding conventions doc.
- fix some wrong links
- fix some code formatting
- fix a file path
---
doc/doxygen/headers/coding_conventions.h | 28 ++++++++++++------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/doc/doxygen/headers/coding_conventions.h b/doc/doxygen/headers/coding_conventions.h
index 81108d1902..08f09258df 100644
--- a/doc/doxygen/headers/coding_conventions.h
+++ b/doc/doxygen/headers/coding_conventions.h
@@ -63,11 +63,11 @@ executable.
- %Functions which return the number of something (number of cells,
degrees of freedom, etc) should start with
n_*
. Example:
- SparsityPattern::n_nonzero_entries().
+ SparsityPatternBase::n_nonzero_elements().
- %Functions which set a bit or flag should start with
set_*
;
functions which clear bits or flags should be named clear_*
.
- Example: CellIterator::set_refine_flag().
+ Example: CellAccessor::set_refine_flag().
- Traditional logical operators should be used instead of their English
equivalents (i.e., use
&&
, ||
, and !
@@ -219,7 +219,7 @@ DOXYGEN ... #endif to prevent Doxygen from picking them up.
expand_instantiations (built from
cmake/scripts/expand_instantiations.cc
) and the parameters are
defined dynamically through cmake depending on your configuration (see
-share/deal.II/template-arguments
in your build directory).
+cmake/config/template-arguments.in
in your build directory).
It is those .inst
files that are eventually included from the
corresponding .cc
files.
@@ -246,8 +246,8 @@ we list here:
consider a trivial implementation of vector addition:
@code
Vector &
- operator += (Vector &lhs,
- const Vector &rhs)
+ operator+=(Vector &lhs,
+ const Vector &rhs)
{
for (unsigned int i=0; iconst Point cell_center = (cell->vertex(0) +
- cell->vertex(1)) / 2;
+ const Point cell_center = (cell->vertex(0) +
+ cell->vertex(1)) / 2;
...
}
...
@@ -460,7 +460,7 @@ we list here:
@code
template
typename Triangulation::cell_iterator
- CellAccessor::child (const unsigned int child_no)
+ CellAccessor::child(const unsigned int child_no)
{
...
return something;
--
2.39.5