1
0
Fork 0
mirror of https://gitlab.ibr.cs.tu-bs.de/tschuber/ns-3-leo.git synced 2025-09-05 20:26:40 +02:00

Update doxygen documentation

This commit is contained in:
Tim Schubert 2020-09-06 21:37:47 +02:00
parent 61b6fd7ea1
commit f17ff6abc6
38 changed files with 1023 additions and 124 deletions

View file

@ -25,12 +25,34 @@
#ifndef NDS_CACHE_HELPER_
#define NDS_CACHE_HELPER_
/**
* \file
* \ingroup leo
* Declares NdCacheHelper
*/
namespace ns3 {
/**
* \ingroup leo
* \brief Neighbor Cache helper fills the neighbor cache
*/
class NdCacheHelper
{
public:
/**
* \brief Fill the cache of devices with addresses
* \param devices devices
* \param interfaces interfaces that have addresses
*/
void Install (NetDeviceContainer &devices, Ipv6InterfaceContainer &interfaces) const;
/**
* \brief Fill the cache of devices with addresses
* \param devicesSrc devices
* \param devicesDst devices
* \param interfaces interfaces that have addresses
*/
void Install (NetDeviceContainer &devicesSrc, NetDeviceContainer &devicesDst, Ipv6InterfaceContainer &interfaces) const;
};