From 6f3dc648ed3f0eb25c18f5131a4f445c23a520ef Mon Sep 17 00:00:00 2001 From: Tom Henderson Date: Fri, 12 Sep 2008 11:34:25 -0700 Subject: [PATCH] doxygen for src/contrib --- src/contrib/contrib.h | 13 +++++++++++++ src/contrib/gtk-config-store.h | 3 +++ 2 files changed, 16 insertions(+) diff --git a/src/contrib/contrib.h b/src/contrib/contrib.h index aec8ba6a2..127e09834 100644 --- a/src/contrib/contrib.h +++ b/src/contrib/contrib.h @@ -1,5 +1,18 @@ /** * \addtogroup contrib Contrib * + * The src/contrib directory is for contributed code that is being maintained + * by the authors, but is not yet part of the main tree. + * For instance, the developers may be requesting feedback on whether anyone + * thinks the contributed model is generally useful to maintain in the main + * tree, or may want feedback on the API or features. If you find the + * code in this directory useful, please let the ns-3 developers know. + * Code may migrate from this directory to the main tree, or may be + * removed due to lack of interest, for a later release. + * * - A class to generate graphs with gnuplot: ns3::Gnuplot and ns3::GnuplotDataset + * - A class to hold configuration data: ns3::ConfigStore and methods to allow the configuration to be read from and written to a file + * - A graphical editor of the config store: ns3::GtkConfigStore + * - An object that garbage collects events: ns3::EventGarbageCollector + * - An object that provides "quick and dirty" delay and jitter estimation: ns3::DelayJitterEstimation */ diff --git a/src/contrib/gtk-config-store.h b/src/contrib/gtk-config-store.h index c1a16408a..9b7cf7bbf 100644 --- a/src/contrib/gtk-config-store.h +++ b/src/contrib/gtk-config-store.h @@ -3,6 +3,9 @@ namespace ns3 { +/** + * \brief A class that provides a GTK-based front end to ns3::ConfigStore + */ class GtkConfigStore { public: