various minor documentation fixes for doxygen
This commit is contained in:
@@ -75,7 +75,7 @@ public:
|
||||
|
||||
/**
|
||||
* @brief constructs a new DockWidget
|
||||
* @param name the name of the dockwidget, should be unique. Use title for user visible text.
|
||||
* @param uniqueName the name of the dockwidget, should be unique. Use title for user visible text.
|
||||
* @param options optional options controlling behaviour
|
||||
*
|
||||
* There's no parent argument. The DockWidget is either parented to FloatingWindow or MainWindow
|
||||
@@ -87,7 +87,7 @@ public:
|
||||
~DockWidgetBase() override;
|
||||
|
||||
/**
|
||||
* @param Constructs a dock widget from its serialized form.
|
||||
* @brief Constructs a dock widget from its serialized form.
|
||||
* @internal
|
||||
*/
|
||||
static DockWidgetBase *deserialize(const LayoutSaver::DockWidget::Ptr &);
|
||||
@@ -109,7 +109,7 @@ public:
|
||||
|
||||
/**
|
||||
* @brief docks @p other widget into the window that contains this one.
|
||||
* Equivalent to @ref MainWindow::addDockWidge() with the difference
|
||||
* Equivalent to @ref MainWindow::addDockWidget() with the difference
|
||||
* that it also supports the case where the top-level window is a
|
||||
* @ref FloatingWindow instead of @ref MainWindow.
|
||||
*
|
||||
|
||||
@@ -69,7 +69,7 @@ public:
|
||||
/// widget that holds the titlebar and tab-widget which holds the
|
||||
/// DockWidgets.
|
||||
///@param parent just forward to Frame's constructor
|
||||
///@param options just forward to Frame's constructor
|
||||
///@param FrameOptions just forward to Frame's constructor
|
||||
virtual Frame* createFrame(QWidgetOrQuick *parent = nullptr, FrameOptions = FrameOption_None) const = 0;
|
||||
|
||||
///@brief Called internally by the framework to create a TitleBar
|
||||
|
||||
@@ -78,7 +78,7 @@ public:
|
||||
|
||||
/**
|
||||
* @brief returns a list of dock widgets which were restored since the last
|
||||
* @ref restoreLayout() or @ref restoreFromDisk()
|
||||
* @ref restoreLayout() or @ref restoreFromFile()
|
||||
*
|
||||
* Useful since some dock widgets can be new, and hence not be included in the last saved layout.
|
||||
*/
|
||||
|
||||
@@ -59,7 +59,7 @@ public:
|
||||
/**
|
||||
* @brief Docks a DockWidget into the central frame, tabbed.
|
||||
* @warning Requires that the MainWindow was constructed with MainWindowOption_HasCentralFrame option.
|
||||
* @param The DockWidget to dock.
|
||||
* @param The dockwidget to dock.
|
||||
*
|
||||
* @sa DockWidgetBase::addDockWidgetAsTab()
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user