feature: add some comment descriptions to the class

release/4.3a0
lvzhaoyang 2015-06-25 11:41:58 -04:00
parent 7ebc9e48e5
commit b569a4ab92
1 changed files with 7 additions and 2 deletions

View File

@ -26,7 +26,12 @@
namespace gtsam {
/// Represents an infinite plane in 3D.
/**
* @brief Represents an infinite plane in 3D, which is composed of a planar normal and its
* perpendicular distance to the origin.
* Currently it provides a transform of the plane, and a norm 1 differencing of two planes.
* Refer to Trevor12iros for more math details.
*/
class GTSAM_EXPORT OrientedPlane3 {
private: