Add '@addtogroup' tag to generate doxygen page

[platform/core/uifw/dali-core.git] / dali / public-api / math / angle-axis.h

diff --git a/dali/public-api/math/angle-axis.h b/dali/public-api/math/angle-axis.h
index cbe692f..1ff1ed3 100644 (file)
--- a/dali/public-api/math/angle-axis.h
+++ b/dali/public-api/math/angle-axis.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_ANGLE_AXIS_H__
-#define __DALI_ANGLE_AXIS_H__
+#ifndef DALI_ANGLE_AXIS_H
+#define DALI_ANGLE_AXIS_H
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,10 @@
  *
  */
 
+// EXTERNAL INCLUDES
+#include <iosfwd>
+#include <ostream>
+
 // INTERNAL INCLUDES
 #include <dali/public-api/math/radian.h>
 #include <dali/public-api/math/vector3.h>
@@ -25,7 +29,7 @@
 namespace Dali
 {
 /**
- * @addtogroup dali_core_object
+ * @addtogroup dali_core_math
  * @{
  */
 
@@ -41,7 +45,7 @@ struct Radian;
 struct AngleAxis
 {
   /**
-   * @brief Create an angle-axis pair.
+   * @brief Creates an angle-axis pair.
    * @SINCE_1_0.0
    */
   AngleAxis()
@@ -50,11 +54,11 @@ struct AngleAxis
   { }
 
   /**
-   * @brief Create an angle-axis pair.
+   * @brief Creates an angle-axis pair.
    *
    * @SINCE_1_0.0
-   * @param[in] initialAngle The initial angle in radians.
-   * @param[in] initialAxis The initial axis.
+   * @param[in] initialAngle The initial angle in radians
+   * @param[in] initialAxis The initial axis
    */
   AngleAxis( Radian initialAngle, const Vector3& initialAxis )
   : angle( initialAngle ),
@@ -66,15 +70,15 @@ struct AngleAxis
 
 };
 
-// compiler generated destructor, copy constructor and assignment operators are ok as this class is POD
+// Compiler generated destructor, copy constructor and assignment operators are ok as this class is POD
 
 /**
- * @brief Compare two angle axis for equality
+ * @brief Compares two angle axis for equality.
  *
  * @SINCE_1_0.0
  * @param lhs angle axis
  * @param rhs angle axis
- * @return true if they are equal
+ * @return True if they are equal
  */
 inline bool operator==( const Dali::AngleAxis& lhs, const Dali::AngleAxis& rhs )
 {
@@ -82,8 +86,21 @@ inline bool operator==( const Dali::AngleAxis& lhs, const Dali::AngleAxis& rhs )
 }
 
 /**
+ * @brief Prints an angle axis.
+ *
+ * @SINCE_1_1.33
+ * @param[in] o The output stream operator
+ * @param[in] angleAxis The angle axis to print
+ * @return The output stream operator
+ */
+inline std::ostream& operator<< (std::ostream& o, const Dali::AngleAxis& angleAxis)
+{
+  return o << "[ Axis: [" << angleAxis.axis.x << ", " << angleAxis.axis.y << ", " << angleAxis.axis.z << "], Angle: " << Degree( angleAxis.angle ).degree << " degrees ]";
+}
+
+/**
  * @}
  */
 } // namespace Dali
 
-#endif // __DALI_ANGLE_AXIS_H__
+#endif // DALI_ANGLE_AXIS_H