kicad-developers team mailing list archive
-
kicad-developers team
-
Mailing list archive
-
Message #29827
[PATCH] Small correction of documentation in BOARD_CONNECTED_ITEM::GetClearance()
See attached.
Best Regards
Simon
From 4b961fda535ffac1051ac51509953fa2a6e1971c Mon Sep 17 00:00:00 2001
From: Simon Kueppers <simon.kueppers@xxxxxx>
Date: Tue, 27 Jun 2017 22:21:29 +0200
Subject: [PATCH] Corrected Typo in documentation of GetClearance function
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="------------2.7.4"
This is a multi-part message in MIME format.
--------------2.7.4
Content-Type: text/plain; charset=UTF-8; format=fixed
Content-Transfer-Encoding: 8bit
---
pcbnew/class_board_connected_item.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
--------------2.7.4
Content-Type: text/x-patch; name="0001-Corrected-Typo-in-documentation-of-GetClearance-func.patch"
Content-Transfer-Encoding: 8bit
Content-Disposition: attachment; filename="0001-Corrected-Typo-in-documentation-of-GetClearance-func.patch"
diff --git a/pcbnew/class_board_connected_item.h b/pcbnew/class_board_connected_item.h
index 8b487c5..dcfbd38 100644
--- a/pcbnew/class_board_connected_item.h
+++ b/pcbnew/class_board_connected_item.h
@@ -135,12 +135,12 @@ public:
/**
* Function GetClearance
- * returns the clearance in 1/10000 inches. If \a aItem is not NULL then the
+ * returns the clearance in internal units. If \a aItem is not NULL then the
* returned clearance is the greater of this object's NETCLASS clearance and
* aItem's NETCLASS clearance. If \a aItem is NULL, then this objects clearance
* is returned.
* @param aItem is another BOARD_CONNECTED_ITEM or NULL
- * @return int - the clearance in 1/10000 inches.
+ * @return int - the clearance in internal units.
*/
virtual int GetClearance( BOARD_CONNECTED_ITEM* aItem = NULL ) const;
--------------2.7.4--
Follow ups