From: bangerth Date: Mon, 25 Feb 2013 04:21:25 +0000 (+0000) Subject: Augment documentation. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=899774a10c52241aefcf99b5e656af8e93ed9d15;p=dealii-svn.git Augment documentation. git-svn-id: https://svn.dealii.org/trunk@28544 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/grid/grid_generator.h b/deal.II/include/deal.II/grid/grid_generator.h index b92327f0bf..eabdfd32f6 100644 --- a/deal.II/include/deal.II/grid/grid_generator.h +++ b/deal.II/include/deal.II/grid/grid_generator.h @@ -590,17 +590,17 @@ public: /** * This class produces a square on the xy-plane with a circular hole - * in the middle, times the interval [0.L] (only in 3d). + * in the middle. Square and circle are centered at the origin. In 3d, this + * geometry is extruded in $z$ direction to the interval $[0,L]$. * * @image html cubes_hole.png * * It is implemented in 2d and 3d, and takes the following arguments: * - * @arg @p inner_radius: size of the + * @arg @p inner_radius: radius of the * internal hole - * @arg @p outer_radius: size of the - * biggest enclosed cylinder - * @arg @p L: extension on the @p z-direction + * @arg @p outer_radius: half of the edge length of the square + * @arg @p L: extension in @p z-direction (only used in 3d) * @arg @p repetitions: number of subdivisions * along the @p z-direction * @arg @p colorize: wether to assign different