add Constants section to doxygen documentation

This commit is contained in:
Mathieu Lacage
2006-09-25 18:55:23 +02:00
parent bd97522a7c
commit fecc1ded2a
2 changed files with 13 additions and 1 deletions

View File

@@ -33,3 +33,7 @@
* \brief Every class exported by the ns3 library is enclosed in the
* ns3 namespace.
*/
/**
* \defgroup constants
* \brief Constants you can change
*/

View File

@@ -30,6 +30,14 @@ namespace ns3 {
template <typename T>
class TagPrettyPrinter;
/**
* \ingroup constants
* \brief Tag maximum size
* The maximum size (in bytes) of a Tag is stored
* in this constant.
*/
#define TAGS_MAX_SIZE 16
class Tags {
public:
inline Tags ();
@@ -51,7 +59,7 @@ public:
inline void removeAll (void);
enum {
SIZE = 16
SIZE = TAGS_MAX_SIZE
};
private:
struct TagData {