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

Unified Diff: src/energy/model/energy-harvester.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/device-energy-model-container.h ('k') | src/energy/model/energy-harvester.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: src/energy/model/energy-harvester.h
===================================================================
--- a/src/energy/model/energy-harvester.h
+++ b/src/energy/model/energy-harvester.h
@@ -32,7 +32,7 @@
#include "ns3/energy-source-container.h"
namespace ns3 {
-
+
class EnergySource;
/**
@@ -51,6 +51,10 @@
class EnergyHarvester : public Object
{
public:
+ /**
+ * \brief Get the type ID.
+ * \return the object TypeId
+ */
static TypeId GetTypeId (void);
EnergyHarvester ();
@@ -105,6 +109,8 @@
virtual void DoDispose (void);
/**
+ * \returns amount of power currently provided by the harvester
+ *
* This method is called by the GetPower method and it needs to be implemented by the
* subclasses of the energy harvester. It returns the actual amount of power that is
* currently provided by the energy harvester.
@@ -129,9 +135,8 @@
Ptr<EnergySource> m_energySource;
protected:
+};
-};
-
} // namespace ns3
#endif /* defined(ENERGY_HARVESTER_H) */
« no previous file with comments | « src/energy/model/device-energy-model-container.h ('k') | src/energy/model/energy-harvester.cc » ('j') | no next file with comments »

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