Skip to content

Commit f4ffb7c

Browse files
committed
Add comments to vectors constructors
1 parent a625aa4 commit f4ffb7c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

source/matplot/axes_objects/vectors.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,36 +17,43 @@ namespace matplot {
1717
class axes_type;
1818
class vectors : public axes_object {
1919
public:
20+
/// \brief Create empty vectors
2021
explicit vectors(class axes_type *parent);
2122

23+
/// \brief Create 2D vectors with fixed origin and incremental u
2224
/// Origin xy = (0,0), u = {1,...n}, v = {v_data}
2325
vectors(class axes_type *parent, const std::vector<double> &v_data,
2426
std::string_view line_spec = "");
2527

28+
/// \brief Create 2D vectors with fixed origin
2629
/// Origin xy = (0,0), u = {u_data}, v = {v_data}
2730
vectors(class axes_type *parent, const std::vector<double> &u_data,
2831
const std::vector<double> &v_data,
2932
std::string_view line_spec = "");
3033

34+
/// \brief Create 3D vectors with fixed origin
3135
/// Origin xy = (0,0,0), u = {u_data}, v = {v_data}, w = {w_data}
3236
vectors(class axes_type *parent, const std::vector<double> &u_data,
3337
const std::vector<double> &v_data,
3438
const std::vector<double> &w_data,
3539
std::string_view line_spec = "");
3640

41+
/// \brief Create 2D vectors with custom origin
3742
vectors(class axes_type *parent, const std::vector<double> &x_data,
3843
const std::vector<double> &y_data,
3944
const std::vector<double> &u_data,
4045
const std::vector<double> &v_data,
4146
std::string_view line_spec = "");
4247

48+
/// \brief Create 2D vectors with custom origin and magnitude colors
4349
vectors(class axes_type *parent, const std::vector<double> &x_data,
4450
const std::vector<double> &y_data,
4551
const std::vector<double> &u_data,
4652
const std::vector<double> &v_data,
4753
const std::vector<double> &m_data,
4854
std::string_view line_spec = "");
4955

56+
/// \brief Create 3D vectors with custom origin
5057
vectors(class axes_type *parent, const std::vector<double> &x_data,
5158
const std::vector<double> &y_data,
5259
const std::vector<double> &z_data,
@@ -55,6 +62,7 @@ namespace matplot {
5562
const std::vector<double> &w_data,
5663
std::string_view line_spec = "");
5764

65+
/// \brief Create 3D vectors with custom origin and magnitude colors
5866
vectors(class axes_type *parent, const std::vector<double> &x_data,
5967
const std::vector<double> &y_data,
6068
const std::vector<double> &z_data,

0 commit comments

Comments
 (0)