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

Correct several Doxygen comments

parent 4ece7080
Pipeline #56206 passed with stage
in 10 minutes and 29 seconds
......@@ -72,7 +72,7 @@ public slots:
void addIndex(const QPersistentModelIndex &index);
signals:
/** @brief Send updated keyframe data to the parameter @index
/** @brief Send updated keyframe data to the parameter \@index
*/
void updateKeyframeData(QPersistentModelIndex index, const QVariant &v);
};
......
......@@ -180,7 +180,7 @@ public:
}
/**
* Get value of precalculated spline in the point @x
* @brief Get value of precalculated spline in the point at \@x
*/
T getValue(T x) const
{
......@@ -196,8 +196,8 @@ public:
protected:
/**
* findRegion - Searches for the region containing @x
* @x0 - out parameter, containing beginning of the region
* @brief findRegion - Searches for the region containing \@x
* @param x - out parameter, containing beginning of the region
* @return - index of the region
*/
int findRegion(T x, T &x0) const
......
......@@ -225,7 +225,7 @@ public:
/** @brief Returns the state of a given clip: AudioOnly, VideoOnly, Disabled (Disabled means it has audio and video capabilities */
PlaylistState::ClipState getClipState(int itemId) const;
/** @brief Add markers on clip @param binId at @param positions with @comments text if given */
/** @brief Add markers on clip \@param binId at \@param positions with @comments text if given */
void addClipMarker(const QString binId, QList<int> positions, QStringList comments = {});
/** @brief Returns a list of selected clip ids.
......
......@@ -140,7 +140,7 @@ public:
void loadProperties(QMap<QString, QString> subProperties);
/** @brief Add all subtitle items to snaps */
void allSnaps(std::vector<int> &snaps);
/** @brief Returns an xml representation of the subtitle with id @sid */
/** @brief Returns an xml representation of the subtitle with id \@sid */
QDomElement toXml(int sid, QDomDocument &document);
/** @brief Returns the size of the space between subtitles */
int getBlankSizeAtPos(int pos) const;
......
......@@ -87,7 +87,7 @@ public:
ClipType::ProducerType clipType() const override;
/** @brief Returns true if item has both audio and video enabled. */
bool hasAudioAndVideo() const override;
/** @brief Returns a clip id if folder contains clip with matching @hash, empty if not found. */
/** @brief Returns a clip id if folder contains clip with matching at \@hash, empty if not found. */
QString childByHash(const QString &hash);
};
......
......@@ -160,7 +160,7 @@ public:
@param description Xml description of the clip
@param parentId Bin id of the parent folder
@param undo,redo: lambdas that are updated to accumulate operation.
@parame readyCallBack: lambda that will be executed when the clip becomes ready. It is given the binId as parameter
@param readyCallBack: lambda that will be executed when the clip becomes ready. It is given the binId as parameter
*/
bool requestAddBinClip(QString &id, const QDomElement &description, const QString &parentId, Fun &undo, Fun &redo,
const std::function<void(const QString &)> &readyCallBack = [](const QString &) {});
......@@ -209,9 +209,9 @@ public:
void setClipWaiting(const QString &binId);
void setClipInvalid(const QString &binId);
/** @brief Returns true if current project has a clip with id @clipId and a hash of @clipHash */
/** @brief Returns true if current project has a clip with id \@clipId and a hash of \@clipHash */
bool validateClip(const QString &binId, const QString &clipHash);
/** @brief Returns clip id if folder @folderId has a clip with hash of @clipHash or empty if not found */
/** @brief Returns clip id if folder "folderId" has a clip with hash of "clipHash" or empty if not found */
QString validateClipInFolder(const QString &folderId, const QString &clipHash);
/** @brief Number of clips in the bin playlist */
......
......@@ -47,7 +47,6 @@ signals:
* @brief A dialog for editing markers and guides.
* @author Jean-Baptiste Mardelle
*/
class SubtitleEdit : public QWidget, public Ui::SubEdit_UI
{
Q_OBJECT
......
......@@ -39,7 +39,6 @@ class ProjectClip;
* @brief A dialog for editing markers and guides.
* @author Jean-Baptiste Mardelle
*/
class VideoTextEdit : public QTextEdit
{
Q_OBJECT
......@@ -148,7 +147,6 @@ private:
* @brief A dialog for editing markers and guides.
* @author Jean-Baptiste Mardelle
*/
class TextBasedEdit : public QWidget, public Ui::TextBasedEdit_UI
{
Q_OBJECT
......
......@@ -231,14 +231,17 @@ public slots:
void slotCreateTextTemplateClip(const QString &group, const QString &groupId, QUrl path);
/** @brief Sets the document as modified or up to date.
* @description If crash recovery is turned on, a timer calls KdenliveDoc::slotAutoSave() \n
*
* If crash recovery is turned on, a timer calls KdenliveDoc::slotAutoSave() \n
* Emits docModified connected to MainWindow::slotUpdateDocumentState \n
*
* @param mod (optional) true if the document has to be saved */
void setModified(bool mod = true);
void slotProxyCurrentItem(bool doProxy, QList<std::shared_ptr<ProjectClip>> clipList = QList<std::shared_ptr<ProjectClip>>(), bool force = false,
QUndoCommand *masterCommand = nullptr);
/** @brief Saves the current project at the autosave location.
* @description The autosave files are in ~/.kde/data/stalefiles/kdenlive/ */
*
* The autosave files are in ~/.kde/data/stalefiles/kdenlive/ */
void slotAutoSave(const QString &scene);
/** @brief Groups were changed, save to MLT. */
void groupsChanged(const QString &groups);
......
......@@ -29,7 +29,7 @@
\brief The DataQueue provides a thread safe container for passing data between
objects.
\threadsafe
threadsafe
DataQueue provides a limited size container for passing data between objects.
One object can add data to the queue by calling push() while another object
......
......@@ -25,11 +25,11 @@
class FrameData;
/*!
\class SharedFrame
\brief The SharedFrame provides thread safe access to Mlt::Frame data.
/**
@class SharedFrame
@brief The SharedFrame provides thread safe access to Mlt::Frame data.
\threadsafe
threadsafe
SharedFrame is a wrapper around Mlt::Frame that provides read-only access to
the frame data. SharedFrame is a reference counted object having only const
......@@ -43,7 +43,6 @@ class FrameData;
TODO: Consider providing a similar class in Mlt++.
*/
class SharedFrame
{
public:
......
......@@ -214,7 +214,7 @@ protected:
/** @brief Transform a group node with no children into a leaf. This implies doing the deregistration to the timeline */
void downgradeToLeaf(int gid);
/** @Brief helper function to change the type of a group.
/** @brief helper function to change the type of a group.
@param id of the groupItem
@param type: new type of the group
*/
......
......@@ -760,7 +760,7 @@ protected:
void registerGroup(int groupId);
/** @brief Deregister and destruct the track with given id.
@parame updateView Whether to send updates to the model. Must be false when called from a constructor/destructor
@param updateView Whether to send updates to the model. Must be false when called from a constructor/destructor
*/
Fun deregisterTrack_lambda(int id);
......
......@@ -340,7 +340,7 @@ public:
Q_INVOKABLE void adjustAllTrackHeight(int trackId, int height);
Q_INVOKABLE void collapseAllTrackHeight(int trackId, bool collapse, int collapsedHeight);
/** @brief Reset track @trackId height to default track height. Adjusts all tracks if @trackId == -1
/** @brief Reset track \@trackId height to default track height. Adjusts all tracks if \@trackId == -1
*/
Q_INVOKABLE void defaultTrackHeight(int trackId);
......@@ -608,7 +608,7 @@ public:
Q_INVOKABLE void resizeSubtitle(int startFrame, int endFrame, int oldEndFrame, bool refreshModel);
/** @brief Add subtitle clip at cursor's position in timeline */
Q_INVOKABLE void addSubtitle(int startframe = -1);
/** @brief Cut a subtitle and split the text at @param pos */
/** @brief Cut a subtitle and split the text at \@param pos */
void cutSubtitle(int id, int cursorPos);
/** @brief Delete subtitle clip with frame as start position*/
Q_INVOKABLE void deleteSubtitle(int frameframe, int endframe, QString Ctext);
......
......@@ -44,7 +44,7 @@ public:
*/
std::unique_ptr<Mlt::Transition> getTransition(const QString &transitionId) const;
/** @brief returns true if the transition corresponding to @transitionId is a composition*/
/** @brief returns true if the transition corresponding to \@transitionId is a composition*/
bool isComposition(const QString &transitionId) const;
/** @brief Returns the id of the transition to be used for compositing */
......
......@@ -34,23 +34,24 @@
namespace Xml {
/** @brief Returns the content of a given tag within the current DomElement.
For example, if your @param element looks like <html><title>foo</title><head>bar</head></html>, passing @tagName = "title" will return foo, and @tagName
For example, if your \@param element looks like <html><title>foo</title><head>bar</head></html>, passing \@tagName = "title" will return foo, and \@tagName
= "head" returns bar
Returns empty string if tag is not found.
*/
QString getSubTagContent(const QDomElement &element, const QString &tagName);
/** @brief Returns the direct children of given @element whose tag name matches given @param tagName
/** @brief Returns the direct children of given \@element whose tag name matches given \@param tagName.
This is an alternative to QDomElement::elementsByTagName which returns also non-direct children
*/
QVector<QDomNode> getDirectChildrenByTagName(const QDomElement &element, const QString &tagName);
/** @brief Returns the content of a children tag of @param element, which respects the following conditions :
- Its type is @param tagName
- It as an attribute named @param attribute with value @param value
/** @brief Returns the content of a children tag of \@param element, which respects the following conditions :
- Its type is \@param tagName
- It as an attribute named \@param attribute with value \@param value
For example, if your element is <html><param val="foo">bar</param></html>, you can retrieve "bar" with parameters: tagName="param", attribute="val", and
value="foo" Returns @param defaultReturn when nothing is found. The methods returns the first match found, so make sure there can't be more than one. If
@param directChildren is true, only immediate children of the node are considered
value="foo" Returns \@param defaultReturn when nothing is found. The methods returns the first match found, so make sure there can't be more than one. If
\@param directChildren is true, only immediate children of the node are considered
*/
QString getTagContentByAttribute(const QDomElement &element, const QString &tagName, const QString &attribute, const QString &value,
const QString &defaultReturn = QString(), bool directChildren = true);
......
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