From: David Wells Date: Fri, 20 Sep 2019 23:00:40 +0000 (-0400) Subject: Fix some minor issues with the coding conventions doc. X-Git-Tag: v9.2.0-rc1~1051^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0bb8fa955394d0b9edd51d4d5ebb467053e9addf;p=dealii.git Fix some minor issues with the coding conventions doc. - fix some wrong links - fix some code formatting - fix a file path --- 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.
  1. %Functions which return the number of something (number of cells, degrees of freedom, etc) should start with n_*. Example: - SparsityPattern::n_nonzero_entries().
  2. + SparsityPatternBase::n_nonzero_elements().
  3. %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().
  4. + Example: CellAccessor::set_refine_flag().
  5. 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.
  6. 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;