From owner-freebsd-libh  Mon Apr 15 12:20:34 2002
Delivered-To: freebsd-libh@freebsd.org
Received: from postal.sdsc.edu (postal.sdsc.edu [132.249.20.114])
	by hub.freebsd.org (Postfix) with ESMTP id 1DB4237B400
	for <freebsd-libh@FreeBSD.ORG>; Mon, 15 Apr 2002 12:20:18 -0700 (PDT)
Received: from multivac.sdsc.edu (multivac.sdsc.edu [132.249.20.57])
	by postal.sdsc.edu (8.11.6/8.11.6/server/36) with ESMTP id g3FJKH713310;
	Mon, 15 Apr 2002 12:20:17 -0700 (PDT)
Received: by multivac (8.11.6+Sun/1.11-SolarisClient)
	id g3FJKHN12622; Mon, 15 Apr 2002 12:20:17 -0700 (PDT)
To: freebsd-libh@FreeBSD.ORG
Subject: cleanup of HSystem 2nd try (stage 2)
From: Max Okumoto <okumoto@ucsd.edu>
Date: 15 Apr 2002 12:20:17 -0700
Message-ID: <hfk7r86a6m.fsf@multivac.sdsc.edu>
Lines: 93
X-Mailer: Gnus v5.5/XEmacs 20.4 - "Emerald"
Sender: owner-freebsd-libh@FreeBSD.ORG
Precedence: bulk
List-ID: <freebsd-libh.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20freebsd-libh>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20freebsd-libh>
X-Loop: FreeBSD.ORG


* Just add doxygen comments.

Index: include/HSystem.hh
===================================================================
RCS file: /home/libh/cvs/libh/include/HSystem.hh,v
retrieving revision 1.7
diff -u -r1.7 HSystem.hh
--- include/HSystem.hh	2002/04/15 16:26:47	1.7
+++ include/HSystem.hh	2002/04/15 19:18:21
@@ -46,6 +46,9 @@
 
 //======================================================================
 
+/**
+ * Represent a libh subsystem object interface generator.
+ */
 class HSystem
 {
     /*
@@ -61,20 +64,49 @@
      typedef list<const char*> CommandAccessToRegister;
      typedef list<pair<string,string> > StaticMethods;
 
+    /**
+     * Constructor.
+     */
      HSystem( const string& aName )
           : name( aName ) {}
+
+    /**
+     * Copy constructor.  XXX This is broken!  None of the other state is
+     * copied!
+     */
      HSystem( const HSystem& aHSystem )
           : name( aHSystem.name ) {}
 
+    /**
+     * Adds the class description and include file to the system definition.
+     *
+     * @param class_desc
+     * @param include_file
+     *
+     * @see find_classes_descriptions.pl
+     */
      void add_class(const ClassDesc *class_desc, const string& include_file)
           {
                descriptions.push_back( class_desc );
                includes.insert( include_file );
           }
 
+    /**
+     * Output header and includes. The output text contains a
+     * warning that it is a generated source file.
+     * 
+     * @param out       stream to send text.
+     */
      void gen_header( ostream& out );
+
      void gen_classes_interfaces( ostream& out );
      void gen_register_command_access( ostream& out );
+
+    /**
+     * Output comment marking end of file.
+     * 
+     * @param out       stream to send text.
+     */
      void gen_footer( ostream& out );
 
      Descriptions descriptions;
@@ -83,8 +115,20 @@
      StaticMethods staticMethods;
 
      string name;
-     bool operator < ( const HSystem& toCompare ) const { return name < toCompare.name; }
-     bool operator == ( const HSystem& toCompare ) const { return name == toCompare.name; }
+
+    /**
+     * LessThan operator.
+     *
+     * @param rhs	Right hand side of the less than operator.
+     */
+     bool operator < (const HSystem& rhs ) const { return name < rhs.name; }
+
+    /**
+     * Equivilance operator.
+     *
+     * @param rhs	Right hand side of the Equivilance operator.
+     */
+     bool operator == ( const HSystem& rhs ) const { return name == rhs.name; }
 
   private:
      void gen_class_header(ostream& out, const ClassDesc *cd);

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-libh" in the body of the message