[Mpqc-commits] mpqc/src/lib/chemistry/qc/wfn obwfn.h,2.3.6.1,2.3.6.2 wfn.h,2.7,2.7.6.1

[Curtis J. <cl...@us...>]

Update of /cvsroot/mpqc/mpqc/src/lib/chemistry/qc/wfn
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv26663/src/lib/chemistry/qc/wfn

Modified Files:
      Tag: release-2-3-branch
	obwfn.h wfn.h 
Log Message:
Numerous documentation improvements.


Index: obwfn.h
===================================================================
RCS file: /cvsroot/mpqc/mpqc/src/lib/chemistry/qc/wfn/obwfn.h,v
retrieving revision 2.3.6.1
retrieving revision 2.3.6.2
diff -u -d -r2.3.6.1 -r2.3.6.2
--- obwfn.h	13 Oct 2005 18:30:13 -0000	2.3.6.1
+++ obwfn.h	28 Apr 2006 00:25:04 -0000	2.3.6.2
@@ -59,7 +59,15 @@
 
  public:
     OneBodyWavefunction(StateIn&);
-    /** The KeyVal constructor.
+    /** This KeyVal constructor is used to construct OneBodyWavefunction
+        objects from the input.
+
+        The keywords used by this constructor are listed below.  The KeyVal
+        constructor for the parent class, Wavefunction, will also be
+        called, so consult the documentation for
+        Wavefunction(const Ref<KeyVal>&) for additional keywords that
+        will be read.
+
         <dl>
 
         <dt><tt>eigenvector_accuracy</tt><dd> Gives the accuracy to which

Index: wfn.h
===================================================================
RCS file: /cvsroot/mpqc/mpqc/src/lib/chemistry/qc/wfn/wfn.h,v
retrieving revision 2.7
retrieving revision 2.7.6.1
diff -u -d -r2.7 -r2.7.6.1
--- wfn.h	18 Mar 2005 05:53:03 -0000	2.7
+++ wfn.h	28 Apr 2006 00:25:04 -0000	2.7.6.1
@@ -107,7 +107,14 @@
     
   public:
     Wavefunction(StateIn&);
-    /** The KeyVal constructor.
+    /** This KeyVal constructor is used to construct Wavefunction
+        objects from the input.
+
+        The keywords used by this constructor are listed below.  The KeyVal
+        constructor for the parent class, MolecularEnergy, will also be
+        called, so consult the documentation for
+        MolecularEnergy(const Ref<KeyVal>&) for additional keywords that
+        will be read.
 
         <dl>