[5457] Fixed doxygen

diff --git a/src/lib/hooks/callout_handle.h b/src/lib/hooks/callout_handle.h
index 45d36fc89328b7d6ade5c55527878b699d1ef369..206c3b6db71223e87a574d599f1a5fd3ddbe167b 100644 (file)
--- a/src/lib/hooks/callout_handle.h
+++ b/src/lib/hooks/callout_handle.h
@@ -344,7 +344,9 @@ public:
     /// @return Name of the current hook or the empty string if none.
     std::string getHookName() const;
 
-    /// @brief Returns pointer to the parking lot for this hook point.
+    /// @brief Returns pointer to the parking lot handle for this hook point.
+    ///
+    /// @return pointer to the parking lot handle
     ParkingLotHandlePtr getParkingLotHandlePtr() const;
 
 private:

diff --git a/src/lib/hooks/hooks_manager.h b/src/lib/hooks/hooks_manager.h
index aff80082b3a21e4ddf0f9a8d7e3a45f2d2f2a1fc..38ff028989deff498bd102e0128c472060a100dc 100644 (file)
--- a/src/lib/hooks/hooks_manager.h
+++ b/src/lib/hooks/hooks_manager.h
@@ -260,10 +260,10 @@ public:
     /// until all hook libraries call @c ParkingLotHandle::unpark to mark
     /// that respective asynchronous operations are completed.
     ///
+    /// @tparam Type of the parked object.
     /// @param hook_name name of the hook point for which the packet is parked.
     /// @param parked_object packet to be parked.
     /// @param unpark_callback callback invoked when the packet is unparked.
-    /// @tparam Type of the parked object.
     template<typename T>
     static void park(const std::string& hook_name, T parked_object,
                      std::function<void()> unpark_callback) {
@@ -276,9 +276,9 @@ public:
     /// value. This is used in the situations when the callouts fail to unpark
     /// the packet for some reason.
     ///
+    /// @tparam T type of the parked object.
     /// @param hook_name name of the hook point for which the packet is parked.
     /// @param parked_object parked object to be unparked.
-    /// @tparam T type of the parked object.
     /// @return true if the specified object has been found, false otherwise.
     template<typename T>
     static bool unpark(const std::string& hook_name, T parked_object) {
@@ -287,9 +287,9 @@ public:
 
     /// @brief Removes parked object without calling a callback.
     ///
+    /// @tparam T type of the parked object.
     /// @param hook_name name of the hook point for which the packet is parked.
     /// @param parked_object parked object to be removed.
-    /// @tparam T type of the parked object.
     /// @return true if the specified object has been found false otherwise.
     template<typename T>
     static bool drop(const std::string& hook_name, T parked_object) {
@@ -301,10 +301,10 @@ public:
     /// Reference counter must be increased at least to 1 before the @c park()
     /// method can be called.
     ///
+    /// @tparam Type of the parked object.
     /// @param hook_name name of the hook point for which the packet is parked.
     /// @param parked_object parked object for which reference counter should
     /// be increased.
-    /// @tparam Type of the parked object.
     template<typename T>
     static void reference(const std::string& hook_name, T parked_object) {
         getHooksManager().referenceInternal(hook_name, parked_object);
@@ -320,10 +320,10 @@ private:
 
     /// @brief Park an object (packet).
     ///
+    /// @tparam Type of the parked object.
     /// @param hook_name Name of the hook point for which the packet is parked.
     /// @param parked_object packet to be parked.
     /// @param unpark_callback callback invoked when the packet is unparked.
-    /// @tparam Type of the parked object.
     template<typename T>
     void parkInternal(const std::string& hook_name, T parked_object,
                       std::function<void()> unpark_callback) {
@@ -333,9 +333,9 @@ private:
 
     /// @brief Signals that the object (packet) should be unparked.
     ///
+    /// @tparam Type of the parked object.
     /// @param hook_name name of the hook point for which the packet is parked.
     /// @param parked_object parked object to be unparked.
-    /// @tparam Type of the parked object.
     /// @return true if the specified object has been found, false otherwise.
     template<typename T>
     bool unparkInternal(const std::string& hook_name, T parked_object) {
@@ -345,9 +345,9 @@ private:
 
     /// @brief Removes parked object without calling a callback.
     ///
+    /// @tparam T type of the parked object.
     /// @param hook_name name of the hook point for which the packet is parked.
     /// @param parked_object parked object to be removed.
-    /// @tparam T type of the parked object.
     /// @return true if the specified object has been found false otherwise.
     template<typename T>
     static bool dropInternal(const std::string& hook_name, T parked_object) {
@@ -357,10 +357,10 @@ private:
 
     /// @brief Increases reference counter for the parked object.
     ///
+    /// @tparam Type of the parked object.
     /// @param hook_name name of the hook point for which the packet is parked.
     /// @param parked_object parked object for which reference counter should
     /// be increased.
-    /// @tparam Type of the parked object.
     template<typename T>
     void referenceInternal(const std::string& hook_name, T parked_object) {
         ServerHooks::getServerHooks().

diff --git a/src/lib/hooks/parking_lots.h b/src/lib/hooks/parking_lots.h
index 88fecd630759b1cc8b7a0efa62bc4e1ff262633f..991fe3d323f503d3a32b408ff371063c92fa9d38 100644 (file)
--- a/src/lib/hooks/parking_lots.h
+++ b/src/lib/hooks/parking_lots.h
@@ -57,10 +57,10 @@ public:
 
     /// @brief Parks an object.
     ///
+    /// @tparam Type of the parked object.
     /// @param parked_object object to be parked, e.g. pointer to a packet.
     /// @param unpark_callback callback function to be invoked when the object
     /// is unparked.
-    /// @tparam Type of the parked object.
     /// @throw InvalidOperation if the @c reference() wasn't called prior to
     /// parking the object.
     template<typename T>
@@ -81,8 +81,8 @@ public:
     /// on the object to be parked. It must be called before the object is
     /// actually parked.
     ///
-    /// @param parked_object object which will be parked.
     /// @tparam Type of the parked object.
+    /// @param parked_object object which will be parked.
     template<typename T>
     void reference(T parked_object) {
         auto it = find(parked_object);
@@ -102,6 +102,7 @@ public:
     /// is 0, the object is unparked and the callback is invoked. Typically, the
     /// callback points to a function which resumes processing of a packet.
     ///
+    /// @tparam Type of the parked object.
     /// @param parked_object parked object to be unparked.
     /// @param force boolean value indicating if the reference counting should
     /// be ignored and the object should be unparked immediately.
@@ -138,7 +139,10 @@ public:
 
     /// @brief Removes parked object without calling a callback.
     ///
+    /// @tparam Type of the parked object.
     /// @param parked_object parked object to be removed.
+    /// @return false if the object couldn't be removed because there is
+    /// no such object, true otherwise.
     template<typename T>
     bool drop(T parked_object) {
         auto it = find(parked_object);
@@ -191,8 +195,8 @@ private:
 
     /// @brief Search for the information about the parked object.
     ///
-    /// @param parked_object object for which the information should be found.
     /// @tparam T parked object type.
+    /// @param parked_object object for which the information should be found.
     /// @return Iterator pointing to the parked object, or @c parking_.end() if
     /// no such object found.
     template<typename T>
@@ -231,8 +235,8 @@ public:
     /// on the object to be parked. It must be called before the object is
     /// actually parked.
     ///
-    /// @param parked_object object which will be parked.
     /// @tparam Type of the parked object.
+    /// @param parked_object object which will be parked.
     template<typename T>
     void reference(T parked_object) {
         parking_lot_->reference(parked_object);
@@ -245,6 +249,7 @@ public:
     /// is 0, the object is unparked and the callback is invoked. Typically, the
     /// callback points to a function which resumes processing of a packet.
     ///
+    /// @tparam Type of the parked object.
     /// @param parked_object parked object to be unparked.
     /// @return false if the object couldn't be unparked because there is
     /// no such object, true otherwise.
@@ -257,7 +262,10 @@ public:
     ///
     /// It ignores any reference counts on the parked object.
     ///
+    /// @tparam Type of the parked object.
     /// @param parked_object parked object to be removed.
+    /// @return false if the object couldn't be removed because there is
+    /// no such object, true otherwise.
     template<typename T>
     bool drop(T parked_object) {
         return (parking_lot_->drop(parked_object));

diff --git a/src/lib/hooks/server_hooks.h b/src/lib/hooks/server_hooks.h
index 2144dd059acb578ea35ed816396eca56ccf013e7..2c9df976ee4672421d9e9bf72236dfa15595a417 100644 (file)
--- a/src/lib/hooks/server_hooks.h
+++ b/src/lib/hooks/server_hooks.h
@@ -154,6 +154,8 @@ public:
     static ServerHooksPtr getServerHooksPtr();
 
     /// @brief Returns pointer to all parking lots.
+    ///
+    /// @return pointer to all parking lots.
     ParkingLotsPtr getParkingLotsPtr() const;
 
     /// @brief Returns pointer to the ParkingLot for the specified hook index.