From a4b32de284b1b3d58038cab737bb81a3934da62a Mon Sep 17 00:00:00 2001 From: bangerth Date: Mon, 13 May 2013 15:31:07 +0000 Subject: [PATCH] Improve documentation somewhat. git-svn-id: https://svn.dealii.org/trunk@29504 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/base/point.h | 29 ++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/deal.II/include/deal.II/base/point.h b/deal.II/include/deal.II/base/point.h index b91947b89f..c33ea938c8 100644 --- a/deal.II/include/deal.II/base/point.h +++ b/deal.II/include/deal.II/base/point.h @@ -53,21 +53,22 @@ class Point : public Tensor<1,dim,Number> public: /** * Standard constructor. Creates - * an origin. + * an object that corresponds to the origin, i.e., all coordinates + * are set to zero. */ Point (); /** * Constructor. Initialize all * entries to zero if - * initialize==true. + * initialize==true (in which case it is equivalent to the default + * constructor) or leaves the elements uninitialized if + * initialize==false. */ explicit Point (const bool initialize); /** - * Convert a tensor to a point. Since no - * additional data is inside a point, - * this is ok. + * Convert a tensor to a point. */ Point (const Tensor<1,dim,Number> &); @@ -76,7 +77,8 @@ public: * points. This function is only * implemented for dim==1 since * the usage is considered unsafe for - * points with dim!=1. + * points with dim!=1 as it would leave some components + * of the point coordinates uninitialized. */ explicit Point (const Number x); @@ -85,18 +87,25 @@ public: * points. This function is only * implemented for dim==2 since * the usage is considered unsafe for - * points with dim!=2. + * points with dim!=2 as it would leave some components + * of the point coordinates uninitialized (if dim>2) or would + * not use some arguments (if dim<2). */ - Point (const Number x, const Number y); + Point (const Number x, + const Number y); /** * Constructor for three dimensional * points. This function is only * implemented for dim==3 since * the usage is considered unsafe for - * points with dim!=3. + * points with dim!=3 as it would leave some components + * of the point coordinates uninitialized (if dim>3) or would + * not use some arguments (if dim<3). */ - Point (const Number x, const Number y, const Number z); + Point (const Number x, + const Number y, + const Number z); /** * Return a unit vector in -- 2.39.5