D18279: Add properties to column

[Yuri Chornoivan]

yurchor added a comment.


  Thanks in advance for fixing minor documentation issues.

INLINE COMMENTS

> AbstractColumn.cpp:545
> +/**
> + * @brief AbstractColumn::properties
> + * Returns the properties hold by this column (no, monotonic increasing, monotonic decreasing,...)

Doxygen's \brief is for classes, structures, etc. This line is redundant. It is sufficient to begin with the next line.

> AbstractColumn.cpp:548
> + * Will be used in XYCurve to improve the search velocity for the y value for a specific x value
> + * @return
> + */

No need to write \return if there will be no description of the returned value.

> Column.cpp:482
> + * Returns the column properties of this curve (monoton increasing, monoton decreasing, ... )
> + * See AbstractColumn::properties
> + * \return

For Doxygen to work, this should be

  \see AbstractColumn::properties

> Column.cpp:483
> + * See AbstractColumn::properties
> + * \return
> + */

No need to write \return if there will be no description of the returned value.

> ColumnPrivate.cpp:1216
> +/*!
> + * \brief ColumnPrivate::updateProperties
> + * updates the properties. Will be called, when data in the column changed.

Doxygen's \brief is for classes, structures, etc. This line is redundant. It is sufficient to begin with the next line.

REPOSITORY
  R262 LabPlot

REVISION DETAIL
  https://phabricator.kde.org/D18279

To: Murmele, asemke
Cc: yurchor, kde-edu, Murmele, narvaez, apol
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-edu/attachments/20190115/21c4ffe9/attachment.html>