[Mockpp-commits] mockpp/mockpp VisitableMockMethod.h,1.14,1.15

[Ewald A. <ewa...@us...>]

Update of /cvsroot/mockpp/mockpp/mockpp
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv3801/mockpp

Modified Files:
	VisitableMockMethod.h 
Log Message:
missing docs

Index: VisitableMockMethod.h
===================================================================
RCS file: /cvsroot/mockpp/mockpp/mockpp/VisitableMockMethod.h,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- VisitableMockMethod.h	31 Oct 2005 19:01:00 -0000	1.14
+++ VisitableMockMethod.h	6 Nov 2005 14:12:07 -0000	1.15
@@ -50,14 +50,25 @@
     */
     VisitableMockMethodBase(const String &name, VisitableMockObject *parent);
 
+  /** Gets the name of the associated method.
+    * @return method name
+    */
     String getMethodName() const;
 
+  /** Gets the method identifier.
+    * @return method identifier
+    */
     std::string getMethodIdentifier() const;
 
+  /** Gets the parent mock object.
+    * @return pointer to mock object
+    */
     VisitableMockObject *getVisitableMockObject() const;
 
   protected:
 
+  /** Throws an exception if available.
+    */
     void throwAvailableException() const
     {
       bool do_throw = true;
@@ -85,6 +96,8 @@
 
   public:
   
+  /** A controller to set up the mock method.
+    */
     template <class VMM>
     class ControllerFor : public VisitableMockObject::Controller
     {
@@ -154,7 +167,6 @@
           this->method->defaultThrowable.take(at.release());
         }
 
-
       /** Clears all expectations and puts the object in record mode again.
         */
         virtual void reset()
@@ -218,6 +230,8 @@
       , returnValues(getMethodName() + MOCKPP_PCHAR("/returnValues"), this)
     {}
 
+  /** A controller to set up the mock method.
+    */
     class ControllerFor : public VisitableMockMethodBase::ControllerFor<VisitableMockReturningMethodBase>
     {
        typedef VisitableMockMethodBase::ControllerFor<VisitableMockReturningMethodBase<R> >  Inherited;
@@ -327,8 +341,7 @@
       : VisitableMockMethodBase(name, parent)
     {}
 
-  /** Construct the item.
-    * @param meth  pointer to the method mock
+  /** A controller to set up the mock method.
     */
     class ControllerFor : public VisitableMockMethodBase::ControllerFor<VisitableMockReturningMethodBase<void> >
     {
@@ -336,6 +349,9 @@
 
       public:
 
+      /** Construct the item.
+        * @param meth  pointer to the method mock
+        */
         ControllerFor (VisitableMockReturningMethodBase<void> *meth)
           : Inherited(meth)
         {