Commit 531a886a authored by Eugen Mohr's avatar Eugen Mohr Committed by Julius Künzel
Browse files

More Doxygen fixes

Adding @class tag. Move the class definition before the class itself and remove whitespace before the class to show @brief text on Visual Studio. Add @todo tag for not defined class.
parent f8a69086
Pipeline #57936 passed with stage
in 8 minutes and 44 seconds
......@@ -27,7 +27,8 @@
#include <memory>
#include <unordered_map>
/** @brief This class represents a generic tree hierarchy
/** @class AbstractTreeModel
@brief This class represents a generic tree hierarchy
*/
class TreeItem;
class AbstractTreeModel : public QAbstractItemModel, public std::enable_shared_from_this<AbstractTreeModel>
......
......@@ -28,7 +28,11 @@
#include <memory>
#include <unordered_map>
/** @brief This class is a generic class to represent items of a tree-like model
class AbstractTreeModel;
/** @class TreeItem
@brief This class is a generic class to represent items of a tree-like model.
It works in tandem with AbstractTreeModel or one of its derived classes.
There is a registration mechanism that takes place: each TreeItem holds a unique Id
that can allow to retrieve it directly from the model.
......@@ -41,8 +45,6 @@
Note that the root is a special object. In particular, it must stay at the root and
must not be declared as the child of any other item.
*/
class AbstractTreeModel;
class TreeItem : public enable_shared_from_this_virtual<TreeItem>
{
public:
......
......@@ -29,9 +29,9 @@
#include <mutex>
#include <unordered_map>
/** @brief This class is the base class for assets (transitions or effets) repositories
/** @class AbstractAssetsRepository
@brief This class is the base class for assets (transitions or effets) repositories
*/
template <typename AssetType> class AbstractAssetsRepository
{
......
......@@ -26,13 +26,14 @@
#include <QQuickWidget>
#include <memory>
/** @brief This class is a generic widget that display the list of available assets
*/
class AssetIconProvider;
class AssetFilter;
class AssetTreeModel;
/** @class AssetListWidget
@brief This class is a generic widget that display the list of available assets
*/
class AssetListWidget : public QQuickWidget
{
Q_OBJECT
......
......@@ -27,6 +27,10 @@
#include <QQuickImageProvider>
#include <memory>
/** @class AssetIconProvider
@brief \@todo Describe class AssetIconProvider
@todo Describe class AssetIconProvider
*/
class AssetIconProvider : public QQuickImageProvider
{
public:
......
......@@ -35,9 +35,7 @@ class QToolButton;
class QComboBox;
class QScrollArea;
/** @brief This class is the widget that provides interaction with the asset currently selected.
That is, it either displays an effectStack or the parameters of a transition
*/
class AssetParameterModel;
class AssetParameterView;
......@@ -47,6 +45,11 @@ class TransitionStackView;
class MixStackView;
class QLabel;
/** @class AssetPanel
@brief This class is the widget that provides interaction with the asset currently selected.
That is, it either displays an effectStack or the parameters of a transition
*/
class AssetPanel : public QWidget
{
Q_OBJECT
......
......@@ -37,15 +37,16 @@ class AssetParameterModel;
class DocUndoStack;
class EffectItemModel;
/** @brief This class is the model for a list of keyframes.
A keyframe is defined by a time, a type and a value
We store them in a sorted fashion using a std::map
*/
enum class KeyframeType { Linear = mlt_keyframe_linear, Discrete = mlt_keyframe_discrete, Curve = mlt_keyframe_smooth };
Q_DECLARE_METATYPE(KeyframeType)
using Keyframe = std::pair<GenTime, KeyframeType>;
/** @class KeyframeModel
@brief This class is the model for a list of keyframes.
A keyframe is defined by a time, a type and a value
We store them in a sorted fashion using a std::map
*/
class KeyframeModel : public QAbstractListModel
{
Q_OBJECT
......
......@@ -37,11 +37,11 @@
class AssetParameterModel;
class DocUndoStack;
/** @brief This class is a container for the keyframe models.
/** @class KeyframeModelList
@brief This class is a container for the keyframe models.
If an asset has several keyframable parameters, each one has its own keyframeModel,
but we regroup all of these in a common class to provide unified access.
*/
class KeyframeModelList : public QObject
{
Q_OBJECT
......
......@@ -32,10 +32,10 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
class Monitor;
class AssetParameterModel;
/** @brief This class helps manage effects that receive data from the monitor's qml overlay to translate
the data and pass it to the model
*/
/** @class KeyframeMonitorHelper
@brief This class helps manage effects that receive data from the monitor's qml overlay to translate
the data and pass it to the model
*/
class KeyframeMonitorHelper : public QObject
{
Q_OBJECT
......
......@@ -21,10 +21,9 @@
#include <QPointF>
/**
/** @class BPoint
* @brief Represents a point in a cubic Bézier spline.
*/
class BPoint
{
public:
......
......@@ -29,6 +29,10 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
class Monitor;
/** @class RotoHelper
@brief \@todo Describe class RotoHelper
@todo Describe class RotoHelper
*/
class RotoHelper : public KeyframeMonitorHelper
{
Q_OBJECT
......
......@@ -27,6 +27,10 @@
#include <QTime>
#include <QUndoCommand>
/** @class AssetCommand
@brief \@todo Describe class AssetCommand
@todo Describe class AssetCommand
*/
class AssetCommand : public QUndoCommand
{
public:
......@@ -46,6 +50,10 @@ private:
QTime m_stamp;
};
/** @class AssetMultiCommand
@brief \@todo Describe class AssetMultiCommand
@todo Describe class AssetMultiCommand
*/
class AssetMultiCommand : public QUndoCommand
{
public:
......@@ -65,6 +73,10 @@ private:
QTime m_stamp;
};
/** @class AssetKeyframeCommand
@brief \@todo Describe class AssetKeyframeCommand
@todo Describe class AssetKeyframeCommand
*/
class AssetKeyframeCommand : public QUndoCommand
{
public:
......@@ -85,6 +97,10 @@ private:
QTime m_stamp;
};
/** @class AssetUpdateCommand
@brief \@todo Describe class AssetUpdateCommand
@todo Describe class AssetUpdateCommand
*/
class AssetUpdateCommand : public QUndoCommand
{
public:
......
......@@ -33,12 +33,6 @@
#include <mlt++/MltProperties.h>
class KeyframeModelList;
/** @brief This class is the model for a list of parameters.
The behaviour of a transition or an effect is typically controlled by several parameters. This class exposes this parameters as a list that can be rendered
using the relevant widgets.
Note that internally parameters are not sorted in any ways, because some effects like sox need a precise order
*/
enum class ParamType {
Double,
......@@ -67,6 +61,13 @@ enum class ParamType {
Hidden
};
Q_DECLARE_METATYPE(ParamType)
/** @class AssetParameterModel
@brief This class is the model for a list of parameters.
The behaviour of a transition or an effect is typically controlled by several parameters. This class exposes this parameters as a list that can be rendered
using the relevant widgets.
Note that internally parameters are not sorted in any ways, because some effects like sox need a precise order
*/
class AssetParameterModel : public QAbstractListModel, public enable_shared_from_this_virtual<AssetParameterModel>
{
Q_OBJECT
......
......@@ -29,9 +29,6 @@
#include <QWidget>
#include <memory>
/** @brief This class is the view for a list of parameters.
*/
class QVBoxLayout;
class QMenu;
class QActionGroup;
......@@ -39,6 +36,9 @@ class AbstractParamWidget;
class AssetParameterModel;
class KeyframeWidget;
/** @class AssetParameterView
@brief This class is the view for a list of parameters.
*/
class AssetParameterView : public QWidget
{
Q_OBJECT
......
......@@ -27,10 +27,11 @@
#include <QWidget>
#include <memory>
/** @brief Base class of all the widgets representing a parameter of an asset (effect or transition)
*/
class AssetParameterModel;
/** @class AbstractParamWidget
@brief Base class of all the widgets representing a parameter of an asset (effect or transition)
*/
class AbstractParamWidget : public QWidget
{
Q_OBJECT
......
......@@ -25,13 +25,11 @@
class KColorButton;
/**
* @class ColorEditWidget
* @brief Provides options to choose a color.
Two mechanisms are provided: color-picking directly on the screen and choosing from a list
* @author Till Theato
/** @class ColorEditWidget
@brief Provides options to choose a color.
Two mechanisms are provided: color-picking directly on the screen and choosing from a list
@author Till Theato
*/
class ColorEditWidget : public AbstractParamWidget
{
Q_OBJECT
......
......@@ -31,7 +31,8 @@
/** State of a point being moved */
enum class State_t { NORMAL, DRAG };
/** This class is a workaround to be able to use templating in the actual class
/** @class __dummy_AbstractCurveWidget
@brief This class is a workaround to be able to use templating in the actual class
Note that Qt doesn't support templated signals, so we have to define a signal for
all possible Point type
*/
......
......@@ -26,6 +26,10 @@
#include <QWidget>
/** @class BezierSplineEditor
@brief \@todo Describe class BezierSplineEditor
@todo Describe class BezierSplineEditor
*/
class BezierSplineEditor : public AbstractCurveWidget<CubicBezierSpline>
{
Q_OBJECT
......
......@@ -21,10 +21,9 @@
#include <QPointF>
/**
* @brief Represents a point in a cubic Bézier spline.
/** @class BPoint
* @brief Represents a point in a cubic Bézier spline.
*/
class BPoint
{
public:
......
......@@ -24,6 +24,10 @@
#include <QList>
#include <QString>
/** @class CubicBezierSpline
@brief \@todo Describe class CubicBezierSpline
@todo Describe class CubicBezierSpline
*/
class CubicBezierSpline
{
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment