Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(880)

Unified Diff: src/energy/model/basic-energy-source.h

Issue 318390043: FInal updates to correct doxygen warnings for the energy module (Closed)
Patch Set: Update with check-style.py changes Created 7 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « src/energy/model/basic-energy-harvester.cc ('k') | src/energy/model/basic-energy-source.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: src/energy/model/basic-energy-source.h
===================================================================
--- a/src/energy/model/basic-energy-source.h
+++ b/src/energy/model/basic-energy-source.h
@@ -37,6 +37,10 @@
class BasicEnergySource : public EnergySource
{
public:
+ /**
+ * \brief Get the type ID.
+ * \return the object TypeId
+ */
static TypeId GetTypeId (void);
BasicEnergySource ();
virtual ~BasicEnergySource ();
@@ -136,16 +140,16 @@
void CalculateRemainingEnergy (void);
private:
- double m_initialEnergyJ; // initial energy, in Joules
- double m_supplyVoltageV; // supply voltage, in Volts
- double m_lowBatteryTh; // low battery threshold, as a fraction of the initial energy
- double m_highBatteryTh; // high battery threshold, as a fraction of the initial energy
- bool m_depleted; // set to true when the remaining energy goes below the low threshold,
+ double m_initialEnergyJ; ///< initial energy, in Joules
+ double m_supplyVoltageV; ///< supply voltage, in Volts
+ double m_lowBatteryTh; ///< low battery threshold, as a fraction of the initial energy
+ double m_highBatteryTh; ///< high battery threshold, as a fraction of the initial energy
+ bool m_depleted; ///< set to true when the remaining energy goes below the low threshold,
// set to false again when the remaining energy exceeds the high threshold
- TracedValue<double> m_remainingEnergyJ; // remaining energy, in Joules
- EventId m_energyUpdateEvent; // energy update event
- Time m_lastUpdateTime; // last update time
- Time m_energyUpdateInterval; // energy update interval
+ TracedValue<double> m_remainingEnergyJ; ///< remaining energy, in Joules
+ EventId m_energyUpdateEvent; ///< energy update event
+ Time m_lastUpdateTime; ///< last update time
+ Time m_energyUpdateInterval; ///< energy update interval
};
« no previous file with comments | « src/energy/model/basic-energy-harvester.cc ('k') | src/energy/model/basic-energy-source.cc » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b