From 960908c60402ddc8cab216f216cb1ebf74157a51 Mon Sep 17 00:00:00 2001 From: Tom Henderson Date: Fri, 3 Feb 2017 10:19:28 -0800 Subject: [PATCH] wifi: Fix wifi documentation build issues --- doc/models/Makefile | 11 ++++++++++- src/wifi/doc/source/wifi-design.rst | 6 ++---- src/wifi/model/wifi-net-device.h | 4 ++-- 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/doc/models/Makefile b/doc/models/Makefile index d97bb7933..51315f7e3 100644 --- a/doc/models/Makefile +++ b/doc/models/Makefile @@ -121,6 +121,9 @@ SOURCEFIGS = \ $(SRC)/wifi/doc/source/figures/snir.dia \ $(SRC)/wifi/doc/source/figures/clear-channel.eps \ $(SRC)/wifi/doc/source/figures/nist-frame-success-rate.eps \ + $(SRC)/wifi/doc/source/figures/nist-frame-success-rate-n.eps \ + $(SRC)/wifi/doc/source/figures/nist-frame-success-rate-ac.eps \ + $(SRC)/wifi/doc/source/figures/nist-frame-success-rate-ax.eps \ $(SRC)/wimax/doc/WimaxArchitecture.dia \ $(SRC)/lte/doc/source/figures/epc-ctrl-arch.dia \ $(SRC)/lte/doc/source/figures/epc-data-flow-dl.dia \ @@ -370,7 +373,10 @@ IMAGES_EPS = \ $(FIGURES)/802-15-4-per-sens.eps \ $(FIGURES)/802-15-4-psr-distance.eps \ $(FIGURES)/clear-channel.eps \ - $(FIGURES)/nist-frame-success-rate.eps + $(FIGURES)/nist-frame-success-rate.eps \ + $(FIGURES)/nist-frame-success-rate-n.eps \ + $(FIGURES)/nist-frame-success-rate-ac.eps \ + $(FIGURES)/nist-frame-success-rate-ax.eps \ # rescale pdf figures as necessary $(FIGURES)/testbed.pdf_width = 5in @@ -425,6 +431,9 @@ $(FIGURES)/lr-wpan-primitives.pdf_width = 3in $(FIGURES)/lr-wpan-arch.pdf_width = 2in $(FIGURES)/clear-channel.pdf_width = 12cm $(FIGURES)/nist-frame-success-rate.pdf_width = 12cm +$(FIGURES)/nist-frame-success-rate-n.pdf_width = 12cm +$(FIGURES)/nist-frame-success-rate-ac.pdf_width = 12cm +$(FIGURES)/nist-frame-success-rate-ax.pdf_width = 12cm IMAGES_PNG = ${IMAGES_EPS:.eps=.png} IMAGES_PDF = ${IMAGES_EPS:.eps=.pdf} diff --git a/src/wifi/doc/source/wifi-design.rst b/src/wifi/doc/source/wifi-design.rst index 369889675..88cbcccd7 100644 --- a/src/wifi/doc/source/wifi-design.rst +++ b/src/wifi/doc/source/wifi-design.rst @@ -206,10 +206,8 @@ The SpectrumWifiPhy framework uses the ``Spectrum`` channel framework, which is not documented herein but in the Spectrum module documentation. -YansWifiChannel -############### - -This is the only channel model presently in the |ns3| wifi module. The +The YansWifiChannel is the only concrete channel model class in +the |ns3| wifi module. The ``ns3::YansWifiChannel`` implementation uses the propagation loss and delay models provided within the |ns3| :ref:`Propagation` module. In particular, a number of propagation models can be added (chained together, diff --git a/src/wifi/model/wifi-net-device.h b/src/wifi/model/wifi-net-device.h index 2ddf465ac..6e2751a32 100644 --- a/src/wifi/model/wifi-net-device.h +++ b/src/wifi/model/wifi-net-device.h @@ -136,9 +136,9 @@ private: */ void LinkDown (void); /** - * Return the WifiChannel this device is connected to. + * Return the Channel this device is connected to. * - * \return WifiChannel + * \return Ptr to Channel object */ Ptr DoGetChannel (void) const; /**