From 7ed11d556ae32af1fabbf484939728364f328d1a Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Fri, 9 Jun 2017 10:27:30 +0200 Subject: [PATCH] document CellId better --- include/deal.II/grid/cell_id.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/include/deal.II/grid/cell_id.h b/include/deal.II/grid/cell_id.h index 5dc08a02c7..2f18a8e86d 100644 --- a/include/deal.II/grid/cell_id.h +++ b/include/deal.II/grid/cell_id.h @@ -32,7 +32,10 @@ DEAL_II_NAMESPACE_OPEN template 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 cell->id() if cell 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 -- 2.39.5