Fix non-undocumented warnings in doxygen, also update doxygen.conf

This commit is contained in:
Josh Pelkey
2010-02-23 12:54:13 -05:00
parent 70b9d522d3
commit b5c8940956
12 changed files with 798 additions and 585 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -61,7 +61,7 @@ public:
/**
* \brief creates a traceBasedStreamer application
* \param dataSize ip the destination ip address to which the stream will be sent
* \param ip the destination ip address to which the stream will be sent
* \param port the destination udp port to which the stream will be sent
* \param traceFile a path to an MPEG4 trace file formatted as follows:
* FrameNo Frametype Time[ms] Length [byte]
@@ -83,7 +83,7 @@ public:
/**
* \brief set the trace file to be used by the application
* \param traceFile a path to an MPEG4 trace file formatted as follows:
* \param filename a path to an MPEG4 trace file formatted as follows:
* Frame No Frametype Time[ms] Length [byte]
* Frame No Frametype Time[ms] Length [byte]
* ...

View File

@@ -127,6 +127,9 @@ public:
* time zone from UTC/GMT. For example, Pacific Standard Time in the US is
* GMT-8, so one would enter -8 for that correction. Defaults to 0 (UTC).
*
* \param swapMode Flag indicating a difference in endianness of the
* writing system. Defaults to false.
*
* \return false if the open succeeds, true otherwise.
*
* \warning Calling this method on an existing file will result in the loss
@@ -253,7 +256,7 @@ public:
* \param f1 First PCAP file name
* \param f2 Second PCAP file name
* \param sec [out] Time stamp of first different packet, seconds. Undefined if files doesn't differ.
* \param uses [out] Time stamp of first different packet, microseconds. Undefined if files doesn't differ.
* \param usec [out] Time stamp of first different packet, microseconds. Undefined if files doesn't differ.
* \param snapLen Snap length (if used)
*/
static bool Diff (std::string const & f1, std::string const & f2,

View File

@@ -252,7 +252,9 @@ public:
*/
double GetSystemLoss (void) const;
/**
* \Set the model antenna height above the node's Z coordinate
* \param heightAboveZ the model antenna height above the node's Z coordinate
*
* Set the model antenna height above the node's Z coordinate
*/
void SetHeightAboveZ (double heightAboveZ);

View File

@@ -109,6 +109,7 @@ public:
/**
* \param packet Packet to store.
* \param hdr 802.11 header for packet.
* \param tStamp time stamp for packet
*
* Stores <i>packet</i> for a possible future retransmission. Retransmission occurs
* if the packet, in a block ack frame, is indicated by recipient as not received.
@@ -156,6 +157,7 @@ public:
/**
* \param recipient Address of peer station involved in block ack mechanism.
* \param tid Traffic ID of transmitted packet.
* \param startingSeq starting sequence field
*
* Puts corresponding agreement in established state and updates number of packets
* and starting sequence field. Invoked typically after a block ack refresh.
@@ -205,7 +207,8 @@ public:
*/
void TearDownBlockAck (Mac48Address recipient, uint8_t tid);
/**
* \param Sequence number of the packet which fragment is part of.
* \param sequenceNumber Sequence number of the packet which fragment is
* part of.
*
* Returns true if another fragment with sequence number <i>sequenceNumber</i> is scheduled
* for retransmission.

View File

@@ -32,7 +32,7 @@ public:
MsduStandardAggregator ();
~MsduStandardAggregator ();
/**
* \param packet Packet we have to insert into </i>aggregatedPacket</i>.
* \param packet Packet we have to insert into <i>aggregatedPacket</i>.
* \param aggregatedPacket Packet that will contain <i>packet</i>, if aggregation is possible,
* \param src Source address of <i>packet</i>.
* \param dest Destination address of <i>packet</i>.

View File

@@ -137,7 +137,7 @@ public:
* \param lrx lower right x value
* \param lry lower right y value
*/
void BoundingBox (double, double, double, double);
void BoundingBox (double ulx, double uly, double lrx, double lry);
private:
NodeContainer m_leftLeaf;

View File

@@ -90,6 +90,7 @@ public:
* \param daddr The destination Ipv4Address
* \param sport The source port number
* \param dport The destination port number
* \param oif The output interface bound. Defaults to null (unspecified).
*/
void Send (Ptr<Packet> packet,
Ipv4Address saddr, Ipv4Address daddr,

View File

@@ -35,8 +35,8 @@ class Waypoint
{
public:
/**
* \param _time time of waypoint.
* \param _position position of waypoint corresponding to the given time.
* \param waypointTime time of waypoint.
* \param waypointPosition position of waypoint corresponding to the given time.
*
* Create a waypoint.
*/

View File

@@ -67,7 +67,7 @@ public:
/**
* \brief Specify application start time
* \param startTime Start time for this application,
* \param start Start time for this application,
* relative to the current simulation time.
*
* Applications start at various times in the simulation scenario.
@@ -80,7 +80,7 @@ public:
/**
* \brief Specify application stop time
* \param stopTime Stop time for this application, relative to the
* \param stop Stop time for this application, relative to the
* current simulation time.
*
* Once an application has started, it is sometimes useful

View File

@@ -529,7 +529,7 @@ public:
* is also possible to bind to mismatching device and address, even if
* the socket can not receive any packets as a result.
*
* \param Netdevice Pointer to Netdevice of desired interface
* \param netdevice Pointer to Netdevice of desired interface
* \returns nothing
*/
virtual void BindToNetDevice (Ptr<NetDevice> netdevice);

View File

@@ -53,7 +53,7 @@ class Ipv4NixVectorRouting : public Ipv4RoutingProtocol
*
* @param node Node pointer
*/
void SetNode (Ptr<Node>);
void SetNode (Ptr<Node> node);
/**
* @brief Called when run-time link topology change occurs