improve doxygen.
--- a/src/core/object-base.h Mon Mar 24 13:15:53 2008 -0700
+++ b/src/core/object-base.h Mon Mar 24 13:25:08 2008 -0700
@@ -41,10 +41,12 @@
namespace ns3 {
/**
- * This base class is really used only to make sure that
- * every subclass has RTTI information and that they all
- * share a single base class to allow us to make type
- * checks across all these types.
+ * \brief implement the ns-3 type and attribute system
+ *
+ * Every class which wants to integrate in the ns-3 type and attribute
+ * system should derive from this base class. This base class provides:
+ * - a way to associate an ns3::TypeId to each object instance
+ * - a way to set and get the attributes registered in the ns3::TypeId.
*/
class ObjectBase
{
--- a/src/core/type-id.h Mon Mar 24 13:15:53 2008 -0700
+++ b/src/core/type-id.h Mon Mar 24 13:25:08 2008 -0700
@@ -322,6 +322,13 @@
* \returns true if the requested attribute could be found, false otherwise.
*/
bool LookupAttributeByName (std::string name, struct AttributeInfo *info) const;
+ /**
+ * \param name the name of the requested trace source
+ * \returns the trace source accessor which can be used to connect and disconnect
+ * trace sinks with the requested trace source on an object instance.
+ *
+ * If no matching trace source is found, this method returns zero.
+ */
Ptr<const TraceSourceAccessor> LookupTraceSourceByName (std::string name) const;
/**