Browse Source

Adds missing documentation to the point_t structure

João Brázio 8 years ago
parent
commit
efd3aabda8
1 changed files with 32 additions and 1 deletions
  1. 32
    1
      Marlin/point_t.h

+ 32
- 1
Marlin/point_t.h View File

23
 #ifndef __POINT_T__
23
 #ifndef __POINT_T__
24
 #define __POINT_T__
24
 #define __POINT_T__
25
 
25
 
26
+/**
27
+ * @brief Cartesian Point
28
+ * @details Represents a three dimensional point on Cartesian coordinate system,
29
+ *          using an additional fourth dimension for the extrusion length.
30
+ *
31
+ * @param x The x-coordinate of the point.
32
+ * @param y The y-coordinate of the point.
33
+ * @param z The z-coordinate of the point.
34
+ * @param e The e-coordinate of the point.
35
+ */
26
 struct point_t {
36
 struct point_t {
27
   float x;
37
   float x;
28
   float y;
38
   float y;
29
   float z;
39
   float z;
30
   float e;
40
   float e;
31
 
41
 
42
+  /**
43
+   * @brief Two dimensional point constructor
44
+   *
45
+   * @param x The x-coordinate of the point.
46
+   * @param y The y-coordinate of the point.
47
+   */
32
   point_t(float const x, float const y)
48
   point_t(float const x, float const y)
33
     : point_t(x, y, NAN, NAN) {}
49
     : point_t(x, y, NAN, NAN) {}
34
 
50
 
51
+  /**
52
+   * @brief Three dimensional point constructor
53
+   *
54
+   * @param x The x-coordinate of the point.
55
+   * @param y The y-coordinate of the point.
56
+   * @param z The z-coordinate of the point.
57
+   */
35
   point_t(float const x, float const y, float const z)
58
   point_t(float const x, float const y, float const z)
36
     : point_t(x, y, z, NAN) {}
59
     : point_t(x, y, z, NAN) {}
37
 
60
 
61
+  /**
62
+   * @brief Tree dimensional point constructor with extrusion length
63
+   *
64
+   * @param x The x-coordinate of the point.
65
+   * @param y The y-coordinate of the point.
66
+   * @param z The z-coordinate of the point.
67
+   * @param e The e-coordinate of the point.
68
+   */
38
   point_t(float const x, float const y, float const z, float const e) {
69
   point_t(float const x, float const y, float const z, float const e) {
39
     this->x = x;
70
     this->x = x;
40
     this->y = y;
71
     this->y = y;
43
   }
74
   }
44
 };
75
 };
45
 
76
 
46
-#endif
77
+#endif // __POINT_T__

Loading…
Cancel
Save