Some refactoring and tidying up of comments.

1 files changed, 82 insertions, 13 deletions

diff --git a/generic/tclOODefineCmds.c b/generic/tclOODefineCmds.c
index 7f3ea18..c08b350 100644
--- a/generic/tclOODefineCmds.c
+++ b/generic/tclOODefineCmds.c
@@ -123,6 +123,7 @@ static const struct DeclaredSlot slots[] = {
  * ----------------------------------------------------------------------
  *
  * BumpGlobalEpoch --
+ *
  *	Utility that ensures that call chains that are invalid will get thrown
  *	away at an appropriate time. Note that exactly which epoch gets
  *	advanced will depend on exactly what the class is tangled up in; in
@@ -167,6 +168,7 @@ BumpGlobalEpoch(
  * ----------------------------------------------------------------------
  *
  * RecomputeClassCacheFlag --
+ *
  *	Determine whether the object is prototypical of its class, and hence
  *	able to use the class's method chain cache.
  *
@@ -189,6 +191,7 @@ RecomputeClassCacheFlag(
  * ----------------------------------------------------------------------
  *
  * TclOOObjectSetFilters --
+ *
  *	Install a list of filter method names into an object.
  *
  * ----------------------------------------------------------------------
@@ -247,6 +250,7 @@ TclOOObjectSetFilters(
  * ----------------------------------------------------------------------
  *
  * TclOOClassSetFilters --
+ *
  *	Install a list of filter method names into a class.
  *
  * ----------------------------------------------------------------------
@@ -309,6 +313,7 @@ TclOOClassSetFilters(
  * ----------------------------------------------------------------------
  *
  * TclOOObjectSetMixins --
+ *
  *	Install a list of mixin classes into an object.
  *
  * ----------------------------------------------------------------------
@@ -350,9 +355,12 @@ TclOOObjectSetMixins(
 	FOREACH(mixinPtr, oPtr->mixins) {
 	    if (mixinPtr != oPtr->selfCls) {
 		TclOOAddToInstances(oPtr, mixinPtr);
-		/* Corresponding TclOODecrRefCount() is in the caller of this
+
+		/*
+		 * Corresponding TclOODecrRefCount() is in the caller of this
 		 * function. 
 		 */
+
 		TclOODecrRefCount(mixinPtr->thisPtr);
 	    }
 	}
@@ -364,6 +372,7 @@ TclOOObjectSetMixins(
  * ----------------------------------------------------------------------
  *
  * TclOOClassSetMixins --
+ *
  *	Install a list of mixin classes into a class.
  *
  * ----------------------------------------------------------------------
@@ -401,9 +410,12 @@ TclOOClassSetMixins(
 	memcpy(classPtr->mixins.list, mixins, sizeof(Class *) * numMixins);
 	FOREACH(mixinPtr, classPtr->mixins) {
 	    TclOOAddToMixinSubs(classPtr, mixinPtr);
-	    /* Corresponding TclOODecrRefCount() is in the caller of this
-	     * function
+
+	    /*
+	     * Corresponding TclOODecrRefCount() is in the caller of this
+	     * function.
 	     */
+
 	    TclOODecrRefCount(mixinPtr->thisPtr);
 	}
     }
@@ -414,6 +426,7 @@ TclOOClassSetMixins(
  * ----------------------------------------------------------------------
  *
  * RenameDeleteMethod --
+ *
  *	Core of the code to rename and delete methods.
  *
  * ----------------------------------------------------------------------
@@ -503,6 +516,7 @@ RenameDeleteMethod(
  * ----------------------------------------------------------------------
  *
  * TclOOUnknownDefinition --
+ *
  *	Handles what happens when an unknown command is encountered during the
  *	processing of a definition script. Works by finding a command in the
  *	operating definition namespace that the requested command is a unique
@@ -581,6 +595,7 @@ TclOOUnknownDefinition(
  * ----------------------------------------------------------------------
  *
  * FindCommand --
+ *
  *	Specialized version of Tcl_FindCommand that handles command prefixes
  *	and disallows namespace magic.
  *
@@ -641,6 +656,7 @@ FindCommand(
  * ----------------------------------------------------------------------
  *
  * InitDefineContext --
+ *
  *	Does the magic incantations necessary to push the special stack frame
  *	used when processing object definitions. It is up to the caller to
  *	dispose of the frame (with TclPopStackFrame) when finished.
@@ -666,7 +682,9 @@ InitDefineContext(
 	return TCL_ERROR;
     }
 
-    /* framePtrPtr is needed to satisfy GCC 3.3's strict aliasing rules */
+    /*
+     * framePtrPtr is needed to satisfy GCC 3.3's strict aliasing rules.
+     */
 
     (void) TclPushStackFrame(interp, (Tcl_CallFrame **) framePtrPtr,
 	    namespacePtr, FRAME_IS_OO_DEFINE);
@@ -681,6 +699,7 @@ InitDefineContext(
  * ----------------------------------------------------------------------
  *
  * TclOOGetDefineCmdContext --
+ *
  *	Extracts the magic token from the current stack frame, or returns NULL
  *	(and leaves an error message) otherwise.
  *
@@ -717,6 +736,7 @@ TclOOGetDefineCmdContext(
  * ----------------------------------------------------------------------
  *
  * GetClassInOuterContext --
+ *
  *	Wrapper round Tcl_GetObjectFromObj to perform the lookup in the
  *	context that called oo::define (or equivalent). Note that this may
  *	have to go up multiple levels to get the level that we started doing
@@ -759,6 +779,7 @@ GetClassInOuterContext(
  * ----------------------------------------------------------------------
  *
  * GenerateErrorInfo --
+ *
  *	Factored out code to generate part of the error trace messages.
  *
  * ----------------------------------------------------------------------
@@ -797,6 +818,7 @@ GenerateErrorInfo(
  * ----------------------------------------------------------------------
  *
  * MagicDefinitionInvoke --
+ *
  *	Part of the implementation of the "oo::define" and "oo::objdefine"
  *	commands that is used to implement the more-than-one-argument case,
  *	applying ensemble-like tricks with dispatch so that error messages are
@@ -860,6 +882,7 @@ MagicDefinitionInvoke(
  * ----------------------------------------------------------------------
  *
  * TclOODefineObjCmd --
+ *
  *	Implementation of the "oo::define" command. Works by effectively doing
  *	the same as 'namespace eval', but with extra magic applied so that the
  *	object to be modified is known to the commands in the target
@@ -934,6 +957,7 @@ TclOODefineObjCmd(
  * ----------------------------------------------------------------------
  *
  * TclOOObjDefObjCmd --
+ *
  *	Implementation of the "oo::objdefine" command. Works by effectively
  *	doing the same as 'namespace eval', but with extra magic applied so
  *	that the object to be modified is known to the commands in the target
@@ -1001,6 +1025,7 @@ TclOOObjDefObjCmd(
  * ----------------------------------------------------------------------
  *
  * TclOODefineSelfObjCmd --
+ *
  *	Implementation of the "self" subcommand of the "oo::define" command.
  *	Works by effectively doing the same as 'namespace eval', but with
  *	extra magic applied so that the object to be modified is known to the
@@ -1068,6 +1093,7 @@ TclOODefineSelfObjCmd(
  * ----------------------------------------------------------------------
  *
  * TclOODefineObjSelfObjCmd --
+ *
  *	Implementation of the "self" subcommand of the "oo::objdefine"
  *	command.
  *
@@ -1101,6 +1127,7 @@ TclOODefineObjSelfObjCmd(
  * ----------------------------------------------------------------------
  *
  * TclOODefineClassObjCmd --
+ *
  *	Implementation of the "class" subcommand of the "oo::objdefine"
  *	command.
  *
@@ -1175,7 +1202,10 @@ TclOODefineClassObjCmd(
     if (oPtr->selfCls != clsPtr) {
 	TclOORemoveFromInstances(oPtr, oPtr->selfCls);
 
-	/* Reference count already incremented 3 lines up. */
+	/*
+	 * Reference count already incremented a few lines up.
+	 */
+
 	oPtr->selfCls = clsPtr;
 
 	TclOOAddToInstances(oPtr, oPtr->selfCls);
@@ -1192,6 +1222,7 @@ TclOODefineClassObjCmd(
  * ----------------------------------------------------------------------
  *
  * TclOODefineConstructorObjCmd --
+ *
  *	Implementation of the "constructor" subcommand of the "oo::define"
  *	command.
  *
@@ -1260,6 +1291,7 @@ TclOODefineConstructorObjCmd(
  * ----------------------------------------------------------------------
  *
  * TclOODefineDeleteMethodObjCmd --
+ *
  *	Implementation of the "deletemethod" subcommand of the "oo::define"
  *	and "oo::objdefine" commands.
  *
@@ -1316,6 +1348,7 @@ TclOODefineDeleteMethodObjCmd(
  * ----------------------------------------------------------------------
  *
  * TclOODefineDestructorObjCmd --
+ *
  *	Implementation of the "destructor" subcommand of the "oo::define"
  *	command.
  *
@@ -1380,6 +1413,7 @@ TclOODefineDestructorObjCmd(
  * ----------------------------------------------------------------------
  *
  * TclOODefineExportObjCmd --
+ *
  *	Implementation of the "export" subcommand of the "oo::define" and
  *	"oo::objdefine" commands.
  *
@@ -1474,6 +1508,7 @@ TclOODefineExportObjCmd(
  * ----------------------------------------------------------------------
  *
  * TclOODefineForwardObjCmd --
+ *
  *	Implementation of the "forward" subcommand of the "oo::define" and
  *	"oo::objdefine" commands.
  *
@@ -1534,6 +1569,7 @@ TclOODefineForwardObjCmd(
  * ----------------------------------------------------------------------
  *
  * TclOODefineMethodObjCmd --
+ *
  *	Implementation of the "method" subcommand of the "oo::define" and
  *	"oo::objdefine" commands.
  *
@@ -1591,6 +1627,7 @@ TclOODefineMethodObjCmd(
  * ----------------------------------------------------------------------
  *
  * TclOODefineMixinObjCmd --
+ *
  *	Implementation of the "mixin" subcommand of the "oo::define" and
  *	"oo::objdefine" commands.
  *
@@ -1634,9 +1671,12 @@ TclOODefineMixinObjCmd(
 	    goto freeAndError;
 	}
 	mixins[i-1] = clsPtr;
-	/* Corresponding TclOODecrRefCount() is in TclOOObjectSetMixins,
+
+	/*
+	 * Corresponding TclOODecrRefCount() is in TclOOObjectSetMixins,
 	 * TclOOClassSetMixinsk, or just below if this function fails.
 	 */
+
 	AddRef(mixins[i-1]->thisPtr);
     }
 
@@ -1661,6 +1701,7 @@ TclOODefineMixinObjCmd(
  * ----------------------------------------------------------------------
  *
  * TclOODefineRenameMethodObjCmd --
+ *
  *	Implementation of the "renamemethod" subcommand of the "oo::define"
  *	and "oo::objdefine" commands.
  *
@@ -1717,6 +1758,7 @@ TclOODefineRenameMethodObjCmd(
  * ----------------------------------------------------------------------
  *
  * TclOODefineUnexportObjCmd --
+ *
  *	Implementation of the "unexport" subcommand of the "oo::define" and
  *	"oo::objdefine" commands.
  *
@@ -1811,6 +1853,7 @@ TclOODefineUnexportObjCmd(
  * ----------------------------------------------------------------------
  *
  * Tcl_ClassSetConstructor, Tcl_ClassSetDestructor --
+ *
  *	How to install a constructor or destructor into a class; API to call
  *	from C.
  *
@@ -1865,6 +1908,7 @@ Tcl_ClassSetDestructor(
  * ----------------------------------------------------------------------
  *
  * TclOODefineSlots --
+ *
  *	Create the "::oo::Slot" class and its standard instances. Class
  *	definition is empty at the stage (added by scripting).
  *
@@ -1908,6 +1952,7 @@ TclOODefineSlots(
  * ----------------------------------------------------------------------
  *
  * ClassFilterGet, ClassFilterSet --
+ *
  *	Implementation of the "filter" slot accessors of the "oo::define"
  *	command.
  *
@@ -1987,6 +2032,7 @@ ClassFilterSet(
  * ----------------------------------------------------------------------
  *
  * ClassMixinGet, ClassMixinSet --
+ *
  *	Implementation of the "mixin" slot accessors of the "oo::define"
  *	command.
  *
@@ -2077,9 +2123,12 @@ ClassMixinSet(
 	    Tcl_SetErrorCode(interp, "TCL", "OO", "SELF_MIXIN", NULL);
 	    goto freeAndError;
 	}
-	/* Corresponding TclOODecrRefCount() is in TclOOClassSetMixins, or just
-	 * below if this function fails
+
+	/*
+	 * Corresponding TclOODecrRefCount() is in TclOOClassSetMixins, or
+	 * just below if this function fails.
 	 */
+
 	AddRef(mixins[i]->thisPtr);
     }
 
@@ -2099,6 +2148,7 @@ ClassMixinSet(
  * ----------------------------------------------------------------------
  *
  * ClassSuperGet, ClassSuperSet --
+ *
  *	Implementation of the "superclass" slot accessors of the "oo::define"
  *	command.
  *
@@ -2199,7 +2249,11 @@ ClassSuperSet(
 	    superclasses[0] = oPtr->fPtr->objectCls;
 	}
 	superc = 1;
-	/* Corresponding TclOODecrRefCount is near the end of this function */
+
+	/*
+	 * Corresponding TclOODecrRefCount is near the end of this function.
+	 */
+
 	AddRef(superclasses[0]->thisPtr);
     } else {
 	for (i=0 ; i<superc ; i++) {
@@ -2229,8 +2283,12 @@ ClassSuperSet(
 		ckfree(superclasses);
 		return TCL_ERROR;
 	    }
-	    /* Corresponding TclOODecrRefCount() is near the end of this
-	     * function */
+
+	    /*
+	     * Corresponding TclOODecrRefCount() is near the end of this
+	     * function.
+	     */
+
 	    AddRef(superclasses[i]->thisPtr);
 	}
     }
@@ -2252,7 +2310,11 @@ ClassSuperSet(
     oPtr->classPtr->superclasses.num = superc;
     FOREACH(superPtr, oPtr->classPtr->superclasses) {
 	TclOOAddToSubclasses(oPtr->classPtr, superPtr);
-	/* To account for the AddRef() earlier in this function */ 
+
+	/*
+	 * To account for the AddRef() earlier in this function.
+	 */
+
 	TclOODecrRefCount(superPtr->thisPtr);
     }
     BumpGlobalEpoch(interp, oPtr->classPtr);
@@ -2264,6 +2326,7 @@ ClassSuperSet(
  * ----------------------------------------------------------------------
  *
  * ClassVarsGet, ClassVarsSet --
+ *
  *	Implementation of the "variable" slot accessors of the "oo::define"
  *	command.
  *
@@ -2406,6 +2469,7 @@ ClassVarsSet(
  * ----------------------------------------------------------------------
  *
  * ObjectFilterGet, ObjectFilterSet --
+ *
  *	Implementation of the "filter" slot accessors of the "oo::objdefine"
  *	command.
  *
@@ -2473,6 +2537,7 @@ ObjFilterSet(
  * ----------------------------------------------------------------------
  *
  * ObjectMixinGet, ObjectMixinSet --
+ *
  *	Implementation of the "mixin" slot accessors of the "oo::objdefine"
  *	command.
  *
@@ -2550,9 +2615,12 @@ ObjMixinSet(
 	    TclStackFree(interp, mixins);
 	    return TCL_ERROR;
 	}
-	/* Corresponding TclOODecrRefCount() is in TclOOObjectSetMixins() or
+
+	/*
+	 * Corresponding TclOODecrRefCount() is in TclOOObjectSetMixins() or
 	 * just above if this function fails.
 	 */
+
 	AddRef(mixins[i]->thisPtr);
     }
 
@@ -2565,6 +2633,7 @@ ObjMixinSet(
  * ----------------------------------------------------------------------
  *
  * ObjectVarsGet, ObjectVarsSet --
+ *
  *	Implementation of the "variable" slot accessors of the "oo::objdefine"
  *	command.
  *