]> https://gitweb.dealii.org/ - dealii.git/commitdiff
document CellId better 4502/head
authorTimo Heister <timo.heister@gmail.com>
Fri, 9 Jun 2017 08:27:30 +0000 (10:27 +0200)
committerTimo Heister <timo.heister@gmail.com>
Fri, 9 Jun 2017 08:27:41 +0000 (10:27 +0200)
include/deal.II/grid/cell_id.h

index 5dc08a02c72304f6d0eb798bf74527205d347857..2f18a8e86d443748060063e8d24d0efea623da7d 100644 (file)
@@ -32,7 +32,10 @@ DEAL_II_NAMESPACE_OPEN
 template <int, int> class Triangulation;
 
 /**
- * A class to represent a unique ID for a cell in a Triangulation.  This class
+ * A class to represent a unique ID for a cell in a Triangulation. It is
+ * returned by <tt>cell->id()</tt> if <tt>cell</tt> is a cell iterator.
+ *
+ * This class
  * stores the index of the coarse cell from which a cell is descendant,
  * together with information on how to reach the cell from that coarse cell
  * (i.e., which child index to take on each level when moving from one cell to

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.