From 7e89a4a2a96c75988f1f7b3474e5ea16b4e61563 Mon Sep 17 00:00:00 2001
From: Jeff Hill <johill@lanl.gov>
Date: Fri, 30 Apr 1999 15:39:41 +0000
Subject: [PATCH] doc

---
 src/cas/generic/casInternal.h |  5 +++-
 src/cas/generic/casPV.cc      |  7 +++--
 src/cas/generic/casdef.h      | 52 +++++++++++++++++++----------------
 3 files changed, 37 insertions(+), 27 deletions(-)

diff --git a/src/cas/generic/casInternal.h b/src/cas/generic/casInternal.h
index 752af2667..21728f7f6 100644
--- a/src/cas/generic/casInternal.h
+++ b/src/cas/generic/casInternal.h
@@ -29,6 +29,9 @@
  *
  * History
  * $Log$
+ * Revision 1.19  1998/12/19 00:04:51  jhill
+ * renamed createPV() to pvAttach()
+ *
  * Revision 1.18  1998/11/18 18:52:49  jhill
  * fixed casChannelI undefined symbols on WIN32
  *
@@ -549,7 +552,7 @@ public:
 
 	//
 	// CA only does 1D arrays for now (and the new server
-	// temporarily does only scalers)
+	// temporarily does only scalars)
 	//
 	inline aitIndex nativeCount();
 
diff --git a/src/cas/generic/casPV.cc b/src/cas/generic/casPV.cc
index 6a2f56aa0..7414f459e 100644
--- a/src/cas/generic/casPV.cc
+++ b/src/cas/generic/casPV.cc
@@ -29,6 +29,9 @@
  *
  * History
  * $Log$
+ * Revision 1.9  1998/06/18 00:09:09  jhill
+ * installed bwd compat casPV constructor
+ *
  * Revision 1.8  1998/06/16 02:30:44  jhill
  * allow PV to be created before the server
  *
@@ -152,7 +155,7 @@ epicsShareFunc aitEnum casPV::bestExternalType() const
 
 //
 // casPV::maxDimension()
-// (base returns zero - scaler)
+// (base returns zero - scalar)
 //
 epicsShareFunc unsigned casPV::maxDimension() const
 {
@@ -161,7 +164,7 @@ epicsShareFunc unsigned casPV::maxDimension() const
 
 //
 // casPV::maxBound()
-// (base returns scaler bound independent of the dimension arg)
+// (base returns scalar bound independent of the dimension arg)
 //
 epicsShareFunc aitIndex casPV::maxBound(unsigned /* dimension */) const
 {
diff --git a/src/cas/generic/casdef.h b/src/cas/generic/casdef.h
index 2484063b5..b92c6a065 100644
--- a/src/cas/generic/casdef.h
+++ b/src/cas/generic/casdef.h
@@ -30,6 +30,9 @@
  * 	Modification Log:
  * 	-----------------
  * 	$Log$
+ * 	Revision 1.22  1998/12/19 00:04:52  jhill
+ * 	renamed createPV() to pvAttach()
+ *
  * 	Revision 1.21  1998/12/07 23:21:53  jhill
  * 	doc
  *
@@ -501,16 +504,16 @@ public:
 	epicsShareFunc virtual void show (unsigned level) const;
 
 	//
-	// Called by the server libary each time that it wishes to
+	// called by the server libary each time that it wishes to
 	// subscribe for PV change notification from the server 
-	// tool via postEvent() below.
+	// tool via postEvent() below
 	//
 	epicsShareFunc virtual caStatus interestRegister ();
 
 	//
 	// called by the server library each time that it wishes to
 	// remove its subscription for PV value change events
-	// from the server tool via caServerPostEvents()
+	// from the server tool via postEvent() below
 	//
 	epicsShareFunc virtual void interestDelete ();
 
@@ -596,36 +599,37 @@ public:
 	// Returns the maximum bounding box for all present and
 	// future data stored within the PV. 
 	//
-	// The routine "dimension()" returns the maximum
-	// number of dimensions in the hypercube (0=scaler, 
+	// The virtual function "dimension()" returns the maximum
+	// number of dimensions in the hypercube (0=scalar, 
 	// 1=array, 2=plane, 3=cube ...}.
 	//
-	// The routine "maxBound(dimension)" returns the 
-	// maximum length of a particular dimension of the
-	// hypercube as follows:
-	// 
-	//	dim equal to	0	1	3	...	
-	//	-------------------------------------------
-	// hypercube 
-	// type	
-	// ---------
+	// The virtual function "maxBound(dimension)" returns the 
+	// maximum number of elements in a particular dimension 
+	// of the hypercube as follows:
+	//
+	// scalar - maxDimension() returns 0
+	//
+	// array - maxDimension() returns 1
+	//        maxBounds(0) supplies number of elements in array
 	//	
-	// array		array
-	//			length
-	//	
-	// plane		x	y	
+	// plane - maxDimension() returns 2
+	//        maxBounds(0) supplies number of elements in X dimension
+	//        maxBounds(1) supplies number of elements in Y dimension
 	//
-	// cube			x	y	z 
+	// cube - maxDimension() returns 3 
+	//        maxBounds(0) supplies number of elements in X dimension
+	//        maxBounds(1) supplies number of elements in Y dimension
+	//        maxBounds(2) supplies number of elements in Z dimension
 	//
 	// .
 	// .
 	// .
 	//
-	// The default (base) "dimension()" returns zero (scaler).
-	// The default (base) "maxBound()" returns scaler bounds
-	// for all dimensions.
+	// The default (base) "dimension()" returns zero (scalar).
+	// The default (base) "maxBound()" returns one (scalar bounds)
+	//       for all dimensions.
 	//
-	// Clients will see that the PV's data is scaler if
+	// Clients will see that the PV's data is scalar if
 	// these routines are not supplied in the derived class.
 	//
 	// If the "dimension" argument to maxBounds() is set to
@@ -634,7 +638,7 @@ public:
 	// set to one then the bound on the second dimension
 	// are being fetched...
 	//
-	epicsShareFunc virtual unsigned maxDimension() const; // return zero if scaler
+	epicsShareFunc virtual unsigned maxDimension() const; // return zero if scalar
 	epicsShareFunc virtual aitIndex maxBound (unsigned dimension) const;
 
 	//