summaryrefslogtreecommitdiff
path: root/ACE/examples/DLL/Magazine.h
diff options
context:
space:
mode:
Diffstat (limited to 'ACE/examples/DLL/Magazine.h')
-rw-r--r--ACE/examples/DLL/Magazine.h54
1 files changed, 26 insertions, 28 deletions
diff --git a/ACE/examples/DLL/Magazine.h b/ACE/examples/DLL/Magazine.h
index 6555974494f..de68758e11f 100644
--- a/ACE/examples/DLL/Magazine.h
+++ b/ACE/examples/DLL/Magazine.h
@@ -1,42 +1,40 @@
/* -*- C++ -*- */
-// $Id$
-// ===========================================================
-//
-//
-// = LIBRARY
-// ACE_wrappers/examples/DLL
-//
-// = FILENAME
-// Magazine.h
-//
-// = DESCRIPTION
-// Abstract class whose methods are implemented by the derived
-// classes.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+//=============================================================================
+/**
+ * @file Magazine.h
+ *
+ * $Id$
+ *
+ * Abstract class whose methods are implemented by the derived
+ * classes.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef MAGAZINE_H
#define MAGAZINE_H
-class Magazine
+/**
+ * @class Magazine
+ *
+ * @brief This is an abstract class used in the DLL example.
+ *
+ * This class simply is an inetrface which the derived classes
+ * will exploit.
+ */
+class Magazine
{
- // = TITLE
- // This is an abstract class used in the DLL example.
- //
- // = DESCRIPTION
- // This class simply is an inetrface which the derived classes
- // will exploit.
public:
+ /// No-op virtual destructor.
virtual ~Magazine (void) {};
- // No-op virtual destructor.
-
+
+ /// This method gives the title of the magazine.
virtual void title (void) = 0;
- // This method gives the title of the magazine.
};
#endif /* MAGAZINE_H */