ONOS-6391: writing API readme's -- topo view.
Change-Id: Icdfcac769bc6c2faaf90acbe6e54c7b7ef9c9044
diff --git a/web/gui/src/main/webapp/_doc/view/README.md b/web/gui/src/main/webapp/_doc/view/README.md
new file mode 100644
index 0000000..f992b5a
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/README.md
@@ -0,0 +1,9 @@
+View Documentation
+==================
+
+With the _Topology_ and _Topology 2_ views being broken up into many
+modules (services), there will be `README` files for each module to document
+its APIs.
+
+For all the other views (that are much simpler, and contained within
+a single `.js` file), a README is probably not necessary.
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.d3.md b/web/gui/src/main/webapp/_doc/view/topo/README.d3.md
new file mode 100644
index 0000000..dfda0ed
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.d3.md
@@ -0,0 +1,49 @@
+Topo D3 Service
+===============
+
+A collection of rendering functions, typically using the D3 library.
+
+
+### Function Descriptions
+
+`initD3(api, zoomer)`
+
+`destroyD3()`
+
+`incDevLabIndex()`
+
+`setDevLabIndex(mode)`
+
+`hostLabel(d)`
+
+`deviceLabel(d)`
+
+`trimLabel(label)`
+
+`updateDeviceLabel(d)`
+
+`updateHostLabel(d)`
+
+`updateDeviceColors(d)`
+
+`deviceExisting(d)`
+
+`hostExisting(d)`
+
+`deviceEnter(d)`
+
+`hostEnter(d)`
+
+`hostExit(d)`
+
+`deviceExit(d)`
+
+`linkEntering(d)`
+
+`applyLinklabels()`
+
+`transformLabel(p, id)`
+
+`applyPortLabels(data, portLabelG)`
+
+`applyNumLinkLabels(data, lblsG)`
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.dialog.md b/web/gui/src/main/webapp/_doc/view/topo/README.dialog.md
new file mode 100644
index 0000000..9089999
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.dialog.md
@@ -0,0 +1,9 @@
+Topo Dialog Service
+===================
+
+Dialog service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.event.md b/web/gui/src/main/webapp/_doc/view/topo/README.event.md
new file mode 100644
index 0000000..0894c09
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.event.md
@@ -0,0 +1,9 @@
+Topo Event Service
+==================
+
+Event service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.filter.md b/web/gui/src/main/webapp/_doc/view/topo/README.filter.md
new file mode 100644
index 0000000..4cc4466
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.filter.md
@@ -0,0 +1,9 @@
+Topo Filter Service
+===================
+
+Filter service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.force.md b/web/gui/src/main/webapp/_doc/view/topo/README.force.md
new file mode 100644
index 0000000..b13b914
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.force.md
@@ -0,0 +1,9 @@
+Topo Force Service
+==================
+
+Force service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.inst.md b/web/gui/src/main/webapp/_doc/view/topo/README.inst.md
new file mode 100644
index 0000000..ff065ba
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.inst.md
@@ -0,0 +1,9 @@
+Topo Instance Service
+=====================
+
+Instance service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.link.md b/web/gui/src/main/webapp/_doc/view/topo/README.link.md
new file mode 100644
index 0000000..bb8cc5d
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.link.md
@@ -0,0 +1,9 @@
+Topo Link Service
+=================
+
+Link service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.map.md b/web/gui/src/main/webapp/_doc/view/topo/README.map.md
new file mode 100644
index 0000000..9c74611
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.map.md
@@ -0,0 +1,9 @@
+Topo Map Service
+================
+
+Map service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.md b/web/gui/src/main/webapp/_doc/view/topo/README.md
index f87c0c4..1c2bea9 100644
--- a/web/gui/src/main/webapp/_doc/view/topo/README.md
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.md
@@ -1,13 +1,44 @@
Topology API Documentation
==========================
-This directory (will eventually) contain a `README` file for each of the
+This directory contains `README` files for each of the
services defined in the _Topology View_, documenting the APIs.
-`README.d3.md`
+`README.d3.md` - utility rendering functions
-`README.dialog.md`
+`README.dialog.md` - creates dialog box
-`README.event.md`
+`README.event.md` - event handling
-etc.
+`README.filter.md` - visual filtering
+
+`README.force.md` - D3 force layout
+
+`README.inst.md` - ONOS instance modeling
+
+`README.link.md` - link modeling
+
+`README.map.md` - geo map service
+
+`README.model.md` - topology modeling
+
+`README.oblique.md` - oblique view rendering
+
+`README.overlay.md` - overlay service
+
+`README.panel.md` - panel functions
+
+`README.protectedIntent.md` - protected intent business logic
+
+`README.protectedIntentOverlay.md` - protected intent overlay definition
+
+`README.select.md` - selection handling
+
+`README.sprite.md` - sprite layer functions
+
+`README.toolbar.md` - toolbar functions
+
+`README.traffic.md` - traffic overlay business logic
+
+`README.trafficNew.md` - traffic overlay definition
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.model.md b/web/gui/src/main/webapp/_doc/view/topo/README.model.md
new file mode 100644
index 0000000..58a5d6b
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.model.md
@@ -0,0 +1,9 @@
+Topo Model Service
+==================
+
+Model service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.oblique.md b/web/gui/src/main/webapp/_doc/view/topo/README.oblique.md
new file mode 100644
index 0000000..136aa3e
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.oblique.md
@@ -0,0 +1,9 @@
+Topo Oblique Service
+====================
+
+Oblique service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.overlay.md b/web/gui/src/main/webapp/_doc/view/topo/README.overlay.md
new file mode 100644
index 0000000..cc5345f
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.overlay.md
@@ -0,0 +1,9 @@
+Topo Overlay Service
+====================
+
+Overlay service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.panel.md b/web/gui/src/main/webapp/_doc/view/topo/README.panel.md
new file mode 100644
index 0000000..3c34e1b
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.panel.md
@@ -0,0 +1,9 @@
+Topo Panel Service
+==================
+
+Panel service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.protectedIntent.md b/web/gui/src/main/webapp/_doc/view/topo/README.protectedIntent.md
new file mode 100644
index 0000000..5b59b12
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.protectedIntent.md
@@ -0,0 +1,9 @@
+Topo Protected Intent Business Logic
+====================================
+
+Protected Intent Business Logic.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.protectedIntentOverlay.md b/web/gui/src/main/webapp/_doc/view/topo/README.protectedIntentOverlay.md
new file mode 100644
index 0000000..40be139
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.protectedIntentOverlay.md
@@ -0,0 +1,9 @@
+Protected Intent Overlay Definition
+===================================
+
+Protected Intent Overlay Definition.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.select.md b/web/gui/src/main/webapp/_doc/view/topo/README.select.md
new file mode 100644
index 0000000..453cd1c
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.select.md
@@ -0,0 +1,9 @@
+Topo Selection Service
+======================
+
+Selection service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.sprite.md b/web/gui/src/main/webapp/_doc/view/topo/README.sprite.md
new file mode 100644
index 0000000..27bf2d5
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.sprite.md
@@ -0,0 +1,9 @@
+Topo Sprite Service
+===================
+
+Sprite service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.toolbar.md b/web/gui/src/main/webapp/_doc/view/topo/README.toolbar.md
new file mode 100644
index 0000000..8f99598
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.toolbar.md
@@ -0,0 +1,9 @@
+Topo Toolbar Service
+====================
+
+Toolbar service API.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.traffic.md b/web/gui/src/main/webapp/_doc/view/topo/README.traffic.md
new file mode 100644
index 0000000..a72c1b8
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.traffic.md
@@ -0,0 +1,9 @@
+Topo Traffic Business Logic
+===========================
+
+Traffic Business Logic.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.trafficNew.md b/web/gui/src/main/webapp/_doc/view/topo/README.trafficNew.md
new file mode 100644
index 0000000..ca75b8d
--- /dev/null
+++ b/web/gui/src/main/webapp/_doc/view/topo/README.trafficNew.md
@@ -0,0 +1,9 @@
+Topo Traffic Overlay Definition
+===============================
+
+Traffic Overlay Definition.
+
+### Function Descriptions
+
+`foo()`
+
diff --git a/web/gui/src/main/webapp/_doc/view/topo2/README.md b/web/gui/src/main/webapp/_doc/view/topo2/README.md
index 8f94f10..2701220 100644
--- a/web/gui/src/main/webapp/_doc/view/topo2/README.md
+++ b/web/gui/src/main/webapp/_doc/view/topo2/README.md
@@ -1,13 +1,91 @@
Topology 2 API Documentation
============================
-This directory (will eventually) contain a `README` file for each of the
+This directory contains `README` files for each of the
services defined in the _Topology 2 View_, documenting the APIs.
-`README.background.md`
+`README.background.md` - maps and sprite layouts management
-`README.breadcrumb.md`
+`README.badge.md` - node badging
-`README.collection.md`
+`README.breadcrumb.md` - region navigation breadcumbs
-etc.
+`README.collection.md` - generic collections of things
+
+`README.detailsPanel.md` - generic details panel functions
+
+`README.device.md` - device node functions
+
+`README.deviceDetailsPanel.md` - device panel functions
+
+`README.event.md` - event handling
+
+`README.force.md` - force layout functions
+
+`README.host.md` - host node functions
+
+`README.hostsPanel.md` - host panel functions
+
+`README.instance.md` - ONOS instance panel functions
+
+`README.keyCommands.md` - keyboard commands
+
+`README.label.md` - label handling
+
+`README.labelCollection.md` - a collection of labels
+
+`README.layout.md` - layout functions
+
+`README.link.md` - link functions
+
+`README.linkLabel.md` - handling link labels
+
+`README.linkPanel.md` - detail panel for links
+
+`README.map.md` - geo map service
+
+`README.mapConfig.md` - geo map configuration
+
+`README.mastership.md` - mastership highlighting
+
+`README.model.md` - internal modeling of topology
+
+`README.nodeModel.md` - node modeling
+
+`README.nodePosition.md` - functions for positioning nodes
+
+`README.noDevicesConnected.md` - no devices rendering
+
+`README.overlay.md` - overlay service
+
+`README.panel.md` - basic panel service
+
+`README.peerRegion.md` - peer region handling
+
+`README.prefs.md` - user preferences service
+
+`README.region.md` - region nodes
+
+`README.regionNavigation.md` - region navigation functions
+
+`README.select.md` - selection model
+
+`README.spriteLayer.md` - sprite layer rendering
+
+`README.subRegion.md` - rendering sub regions
+
+`README.subRegionPanel.md` - detail panel for selected region
+
+`README.summaryPanel.md` - summary panel rendering
+
+`README.toolbar.md` - toolbar rendering
+
+`README.traffic.md` - traffic business logic
+
+`README.trafficOverlay.md` - traffic overlay definition
+
+`README.view.md` - view state variables
+
+`README.viewController.md` - view controller base class
+
+`README.zoom.md` - zoom event handler