[gcjx] Patch: FYI: minor documentation update

Tom Tromey tromey@redhat.com
Mon Sep 12 01:33:00 GMT 2005


I'm checking this in on the gcjx branch.

This adds some more documentation to model_class.  The intent here is
to provide doxygen docs for at least the library parts of gcjx.  We're
rather far from this at the moment however.

Tom

Index: ChangeLog
from  Tom Tromey  <tromey@redhat.com>
	* model/class.hh (class model_class): Added some documentation.

Index: model/class.hh
===================================================================
RCS file: /cvs/gcc/gcc/gcjx/model/Attic/class.hh,v
retrieving revision 1.1.2.4
diff -u -r1.1.2.4 class.hh
--- model/class.hh 17 Apr 2005 21:26:15 -0000 1.1.2.4
+++ model/class.hh 12 Sep 2005 01:32:31 -0000
@@ -57,6 +57,17 @@
   AllMethods::const_iterator it;
 };
 
+/// This represents a class declaration.  It has attributes covering
+/// all the needed functionality (fields, methods, etc).  It also
+/// knows the inheritance rules and other things like that.
+///
+
+/// A model_class is also used as the type of a class.  In particular,
+/// for ordinary classes, the model_class is both the declaration and
+/// the type.  For generic classes, the model_class is the declaration
+/// and the raw type.  Parameterizations of the class -- including the
+/// parameterization where each type variable "maps to itself" -- are
+/// represented by model_class_instance.
 class model_class : public model_type, public Iname, public IContext,
 		    public IDeprecatable, public IAnnotatable,
 		    public IModifiable, public IMember, public IScope



More information about the Java-patches mailing list