Merge branch 'release/20.12'

[dolphin.git] / src / dolphinurlnavigator.h

diff --git a/src/dolphinurlnavigator.h b/src/dolphinurlnavigator.h
index a154287995a209b4e8c759d8fc1e2b0bfb9ce85a..9bcc32b4d1463d1cfbcc37a31dd3068b92cdb312 100644 (file)
--- a/src/dolphinurlnavigator.h
+++ b/src/dolphinurlnavigator.h
@@ -15,8 +15,9 @@
  *
  * Makes sure that Dolphin preferences and settings are
  * applied to all constructed DolphinUrlNavigators.
- *
  * @see KUrlNavigator
+ *
+ * To apply changes to all instances of this class @see DolphinUrlNavigatorsController.
  */
 class DolphinUrlNavigator : public KUrlNavigator
 {
@@ -55,6 +56,9 @@ public:
     /**
      * Retrieve the visual state of this DolphinUrlNavigator.
      * If two DolphinUrlNavigators have the same visual state they should look identical.
+     *
+     * @return a copy of the visualState of this object. Ownership of this copy is transferred
+     *         to the caller via std::unique_ptr.
      */
     std::unique_ptr<VisualState> visualState() const;
     /**