From 3efa392d1f4688434e4122e806220aa19b4bb643 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89ric=20Lemoine?= <eric.lemoine@gmail.com>
Date: Thu, 5 Jul 2012 12:01:27 +0200
Subject: [PATCH] ol3.md updates

---
 doc/ol3.md | 34 ++++++++++++++++++++--------------
 1 file changed, 20 insertions(+), 14 deletions(-)

diff --git a/doc/ol3.md b/doc/ol3.md
index d903271750..2e81ffd114 100644
--- a/doc/ol3.md
+++ b/doc/ol3.md
@@ -1,6 +1,7 @@
 CLASS HIERARCHY
 ===============
 
+```
 goog.math.Coordinate  // Simple 2D point
 
 
@@ -8,7 +9,6 @@ goog.math.Coordinate3
 |
 +- TileCoord
 
-
 goog.math.Box
 |
 +- TileBounds  // A range of tiles in two dimensions, integer coordinates, z not stored
@@ -66,11 +66,13 @@ goog.events.EventTarget
 |  +- TileQueue
 |
 +- Tile
+```
 
 
 Layer renderer hierarchy
 ------------------------
 
+```
 goog.events.EventTarget
 |
 +- MVCObject
@@ -100,25 +102,26 @@ goog.events.EventTarget
       |  |  +- VMLHTMLVectorLayerRenderer
       |  |
       |  +- WebGLVectorLayerRenderer
+```
 
 
 OBJECT PROPERTIES AND METHODS
 =============================
 
 Notation:
-   property type  // property with type, trailing ? indicates unsure
-                  // getters and setters are assumed to exist
-   f(args) -> type  // function taking args returning type
-   f(args) -> type = something  // f is a trivial wrapper around something
-   fires 'x'  // fires events of type 'x'
 
+- `property type`  property with type, trailing ? indicates unsure, getters and setters are assumed to exist.
+- `f(args) -> type`  function taking args returning type.
+- `f(args) -> type = something`  f is a trivial wrapper around something.
+- `fires 'x'`  fires events of type 'x'.
 
 Principles:
-   All non-trivial objects inherit from MVCObject
-   All non-trivial collections are either MVCArrays or a child class thereof
-   Resolutions are Array.<number>, infinitely scalable resoueces (e.g. vectore layers) have resolutions == null
 
+- All non-trivial objects inherit from `MVCObject`.
+- All non-trivial collections are either `MVCArrays` or a child class thereof.
+- Resolutions are `Array.<number>`, infinitely scalable resources (e.g. vectore layers) have resolutions == null.
 
+```
 MVCObject
   as Google Maps MVCObject
   freeze()
@@ -198,13 +201,16 @@ Renderer
    map Map
    camera Camera
    getCapabilities() -> Array.<string>  // maybe ?
+```
+
+Questions:
+
+- Store tile layer extent in TileLayer or in TileGrid?  (not clear)
+- Who determines "best" resolution?  (static function?)
 
 
-Question: store tile layer extent in TileLayer or in TileGrid?  (not clear)
-Question: who determines "best" resolution?  (static function?)
-
-
-Todo: if tile layer extent stored in TileLayer rather than TileGrid then extent will occasionally need to be passed to TileGrid functions for cropping
+Todo: if tile layer extent stored in TileLayer rather than TileGrid then extent
+will occasionally need to be passed to TileGrid functions for cropping.
 
 DESIGN ASSERTIONS
 =================