Update doxygen documentation

model/leo-circular-orbit-position-allocator.h

@@ -21,32 +21,54 @@
 
 #include "ns3/position-allocator.h"
 
+/**
+ * \file
+ * \ingroup leo
+ *
+ * Declaration of LeoCircularOrbitAllocator
+ */
+
 namespace ns3 {
 
 /**
- * \brief Allocate pairs of latitude and longitude (offset within orbit) for
+ * \ingroup leo
+ * \brief Allocate pairs of longitude and latitude (offset within orbit) for
  * use in LeoCircularOrbitMobilityModel
  */
 class LeoCircularOrbitAllocator : public PositionAllocator
 {
 public:
   /**
-   * Register this type with the TypeId system.
+   * \brief Get the type ID.
    * \return the object TypeId
    */
   static TypeId GetTypeId ();
 
+  /// constructor
   LeoCircularOrbitAllocator ();
+  /// destructor
   virtual ~LeoCircularOrbitAllocator ();
 
+  /**
+   * \brief Gets the next position on the latitude longitude grid
+   *
+   * If all positions have been returned once, the first position is returned
+   * again and so on.
+   *
+   * \return the next latitude, longitude pair
+   */
   virtual Vector GetNext (void) const;
   virtual int64_t AssignStreams (int64_t stream);
 
 private:
+  /// Number of orbits two distribute the satellites on
   uint64_t m_numOrbits;
+  /// Number of satellites per orbit
   uint64_t m_numSatellites;
 
+  /// The last orit that has been assigned
   mutable uint64_t m_lastOrbit;
+  /// The last position inside the orbit that has been assigned
   mutable uint64_t m_lastSatellite;
 };