Date: 15 Apr 2002 12:20:17 -0700 From: Max Okumoto <okumoto@ucsd.edu> To: freebsd-libh@FreeBSD.ORG Subject: cleanup of HSystem 2nd try (stage 2) Message-ID: <hfk7r86a6m.fsf@multivac.sdsc.edu>
next in thread | raw e-mail | index | archive | help
* 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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?hfk7r86a6m.fsf>