From 0ea409f8d54ed1850e9cf28327f374c920d4b0b0 Mon Sep 17 00:00:00 2001
From: Florent Lamiraux <florent@laas.fr>
Date: Wed, 1 Jul 2015 11:08:57 +0200
Subject: [PATCH] Cosmetic: add documentation.
---
include/hpp/fcl/narrowphase/gjk.h | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/include/hpp/fcl/narrowphase/gjk.h b/include/hpp/fcl/narrowphase/gjk.h
index 51ac2684..bd592408 100644
--- a/include/hpp/fcl/narrowphase/gjk.h
+++ b/include/hpp/fcl/narrowphase/gjk.h
@@ -51,6 +51,8 @@ namespace details
Vec3f getSupport(const ShapeBase* shape, const Vec3f& dir);
/// @brief Minkowski difference class of two shapes
+///
+/// \note The Minkowski difference is expressed in the frame of the first shape.
struct MinkowskiDiff
{
/// @brief points to two shapes
@@ -118,6 +120,8 @@ struct MinkowskiDiff
/// @brief class for GJK algorithm
+///
+/// \note The computations are performed in the frame of the first shape.
struct GJK
{
struct SimplexV
--
GitLab