Fix unused comments causing accidental Doxygen warnings

signetlabdei · Mar 18, 2024 · dbef770 · dbef770
1 parent 6f288a0
commit dbef770
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 24 deletions.
diff --git a/model/end-device-lorawan-mac.h b/model/end-device-lorawan-mac.h
@@ -191,22 +191,22 @@ class EndDeviceLorawanMac : public LorawanMac
      */
     LoraDeviceAddress GetDeviceAddress();
 
-    /**
-     * Set a value for the RX1DROffset parameter.
-     *
-     * This value decides the offset to use when deciding the DataRate of the
-     * downlink transmission during the first receive window from the
-     * replyDataRateMatrix.
-     *
-     * \param rx1DrOffset The value to set for the offset.
-     */
+    ///**
+    // * Set a value for the RX1DROffset parameter.
+    // *
+    // * This value decides the offset to use when deciding the DataRate of the
+    // * downlink transmission during the first receive window from the
+    // * replyDataRateMatrix.
+    // *
+    // * \param rx1DrOffset The value to set for the offset.
+    // */
     // void SetRx1DrOffset (uint8_t rx1DrOffset);
 
-    /**
-     * Get the value of the RX1DROffset parameter.
-     *
-     * \return The value of the RX1DROffset parameter.
-     */
+    ///**
+    // * Get the value of the RX1DROffset parameter.
+    // *
+    // * \return The value of the RX1DROffset parameter.
+    // */
     // uint8_t GetRx1DrOffset ();
 
     /**

diff --git a/model/gateway-status.h b/model/gateway-status.h
@@ -98,9 +98,9 @@ class GatewayStatus : public Object
      */
     Ptr<GatewayLorawanMac> GetGatewayMac();
 
-    /**
-     * Set a pointer to this gateway's MAC instance.
-     */
+    ///**
+    // * Set a pointer to this gateway's MAC instance.
+    // */
     // void SetGatewayMac (Ptr<GatewayLorawanMac> gwMac);
 
     /**

diff --git a/model/lora-radio-energy-model.h b/model/lora-radio-energy-model.h
@@ -65,8 +65,6 @@ class LoraRadioEnergyModelPhyListener : public EndDeviceLoraPhyListener
     /**
      * \brief Switches the LoraRadioEnergyModel to RX state.
      *
-     * \param duration the expected duration of the packet reception.
-     *
      * Defined in ns3::LoraEndDevicePhyListener
      */
     void NotifyRxStart() override;

diff --git a/model/sub-band.h b/model/sub-band.h
@@ -68,11 +68,11 @@ class SubBand : public Object
      */
     double GetFirstFrequency() const;
 
-    /**
-     * Get the last frequency of the subband.
-     *
-     * \return The lowest frequency of the SubBand.
-     */
+    ///**
+    // * Get the last frequency of the subband.
+    // *
+    // * \return The lowest frequency of the SubBand.
+    // */
     // double GetLastFrequency ();
 
     /**