Skip to content

Commit

Permalink
brief command added to the class description inside the documentation…
Browse files Browse the repository at this point in the history
… of vector_unit_nd.dox
  • Loading branch information
iarfen committed Jul 13, 2024
1 parent d7017dd commit c51e88c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/dox/units/vector_unit_nd.dox
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/** \class scifir::vector_unit_nd
* Class that creates a vector in ND, which means a variable number of dimensions. A vector_unit_nd can change to be in 1D, in 2D or in 3D, but it cannot be in more than one dimension at the same time. The member-variables of vector_unit_nd are the value and the vector<dimension> of scalar_unit, and a vector<angle> angles. The number of angles is equal to the number of dimensions vector unit has - 1. In 1D vector_unit_nd doesn't has angles, in 2D vector_unit_nd is in **polar coordniates** an has 1 angle, and in 3D vector_unit_nd is in **spherical coordinates** an has 2 angles.
* \brief Class that creates a vector in ND, which means a variable number of dimensions. A vector_unit_nd can change to be in 1D, in 2D or in 3D, but it cannot be in more than one dimension at the same time. The member-variables of vector_unit_nd are the value and the vector<dimension> of scalar_unit, and a vector<angle> angles. The number of angles is equal to the number of dimensions vector unit has - 1. In 1D vector_unit_nd doesn't has angles, in 2D vector_unit_nd is in **polar coordniates** an has 1 angle, and in 3D vector_unit_nd is in **spherical coordinates** an has 2 angles.

* \fn vector_unit_nd::vector_unit_nd()
* \brief Default constructor. The value is 0, the dimensions are empty and the angles are empty.
Expand Down

0 comments on commit c51e88c

Please sign in to comment.