kicad-developers team mailing list archive

[Alejandro Garcia Montoro <alejandro.garciamontoro@xxxxxxxxx>]

Minor patch: fixes two comments in shape_line_chain.h that described the
old reference-wise behaviour of SEG.

From 7a6a6914c534f8efb76c44d762c4710220a77f5a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alejandro=20Garc=C3=ADa=20Montoro?=
 <alejandro.garciamontoro@xxxxxxxxx>
Date: Mon, 17 Apr 2017 10:27:04 +0200
Subject: [PATCH] Modify comments in shape_line_chain.h that described the old
 reference-wise behaviour of SEG class.
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="------------2.12.2"

This is a multi-part message in MIME format.
--------------2.12.2
Content-Type: text/plain; charset=UTF-8; format=fixed
Content-Transfer-Encoding: 8bit

---
 include/geometry/shape_line_chain.h | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)


--------------2.12.2
Content-Type: text/x-patch; name="0001-Modify-comments-in-shape_line_chain.h-that-described.patch"
Content-Transfer-Encoding: 8bit
Content-Disposition: attachment; filename="0001-Modify-comments-in-shape_line_chain.h-that-described.patch"

diff --git a/include/geometry/shape_line_chain.h b/include/geometry/shape_line_chain.h
index df57d1078..22df73be3 100644
--- a/include/geometry/shape_line_chain.h
+++ b/include/geometry/shape_line_chain.h
@@ -190,11 +190,10 @@ public:
     /**
      * Function Segment()
      *
-     * Returns a segment referencing to the segment (index) in the line chain.
-     * Modifying ends of the returned segment will modify corresponding points in the line chain.
+     * Returns a copy of the aIndex-th segment in the line chain.
      * @param aIndex: index of the segment in the line chain. Negative values are counted from
      * the end (i.e. -1 means the last segment in the line chain)
-     * @return SEG referenced to given segment in the line chain
+     * @return SEG - aIndex-th segment in the line chain
      */
     SEG Segment( int aIndex )
     {
@@ -210,10 +209,10 @@ public:
     /**
      * Function CSegment()
      *
-     * Returns a read-only segment referencing to the segment (index) in the line chain.
+     * Returns a constant copy of the aIndex-th segment in the line chain.
      * @param aIndex: index of the segment in the line chain. Negative values are counted from
      * the end (i.e. -1 means the last segment in the line chain)
-     * @return SEG referenced to given segment in the line chain
+     * @return const SEG - aIndex-th segment in the line chain
      */
     const SEG CSegment( int aIndex ) const
     {

--------------2.12.2--