# HG changeset patch
# User Benjamin Golinvaux <bgo@osimis.io>
# Date 1559045598 -7200
# Node ID a6ba676a93e235ee7d86b435310c3e89e41c1190
# Parent  11fc84650e4b3cc04fb0f54611e273424c1cf5ef
Added doc

diff -r 11fc84650e4b -r a6ba676a93e2 Framework/Volumes/VolumeImageGeometry.h
--- a/Framework/Volumes/VolumeImageGeometry.h	Tue May 28 14:13:10 2019 +0200
+++ b/Framework/Volumes/VolumeImageGeometry.h	Tue May 28 14:13:18 2019 +0200
@@ -115,6 +115,15 @@
     bool DetectProjection(VolumeProjection& projection,
                           const Vector& planeNormal) const;
 
+    /**
+    Being given a cutting plane, this method will determine if it is an
+    axial, sagittal or coronal cut and returns 
+    the slice number corresponding to this cut.
+
+    If the cutting plane is not parallel to the tree x = 0, y = 0 or z = 0
+    planes, it is considered as arbitrary and the method returns false. 
+    Otherwise, it returns true.
+    */
     bool DetectSlice(VolumeProjection& projection,
                      unsigned int& slice,
                      const CoordinateSystem3D& plane) const;