From aa0bb75f4d769c3f873fc253aa5613f857690710 Mon Sep 17 00:00:00 2001
From: Richard Fairhurst <richard@systemeD.net>
Date: Thu, 12 Jul 2012 15:38:30 +0100
Subject: [PATCH] NodeUI and WayUI documentation

---
 js/iD/renderer/NodeUI.js | 2 ++
 js/iD/renderer/WayUI.js  | 4 ++++
 2 files changed, 6 insertions(+)

diff --git a/js/iD/renderer/NodeUI.js b/js/iD/renderer/NodeUI.js
index 507b7cef8..4f3e36c75 100755
--- a/js/iD/renderer/NodeUI.js
+++ b/js/iD/renderer/NodeUI.js
@@ -9,6 +9,7 @@ define(['dojo/_base/declare','dojo/_base/lang','dojo/_base/array','dojox/gfx/_ba
 
 declare("iD.renderer.NodeUI", [iD.renderer.EntityUI], {
 	constructor:function() {
+		// summary:		A UI (rendering) representing a node.
 		this.redraw();
 	},
 	getEnhancedTags:function() {
@@ -18,6 +19,7 @@ declare("iD.renderer.NodeUI", [iD.renderer.EntityUI], {
 		return tags;
 	},
 	redraw:function() {
+		// summary:		Draw the object (mostly icons) and add hitzone sprites.
 		var node=this.entity;
 		this.removeSprites();
 
diff --git a/js/iD/renderer/WayUI.js b/js/iD/renderer/WayUI.js
index 719ce73f8..ac26301c2 100755
--- a/js/iD/renderer/WayUI.js
+++ b/js/iD/renderer/WayUI.js
@@ -1,5 +1,6 @@
 // iD/renderer/WayUI.js
 // WayUI classes for iD
+// **** TODO:
 // multipolygon support - http://mail.dojotoolkit.org/pipermail/dojo-interest/2011-January/052042.html
 // support 'interactive'
 // line decoration, dots etc.
@@ -13,6 +14,7 @@ define(['dojo/_base/declare','dojo/_base/lang','iD/renderer/EntityUI'], function
 
 declare("iD.renderer.WayUI", [iD.renderer.EntityUI], {
 	constructor:function() {
+		// summary:		A UI (rendering) representing a way.
 		this.redraw();
 	},
 	getEnhancedTags:function() {
@@ -21,9 +23,11 @@ declare("iD.renderer.WayUI", [iD.renderer.EntityUI], {
 		return tags;
 	},
 	recalculate:function() {
+		// summary:		Not yet implemented - calculate length/centrepoint of UI for use in rendering.
 		// ** FIXME: todo
 	},
 	redraw:function() {
+		// summary:		Draw the object and add hitzone sprites.
 		var way=this.entity;
 		var maxwidth=4;
 		var i;