[libchamplain: 33/45] Add descriptive comment on path layer rendering.

[Jiří Techet <jiritechet src gnome org>]

commit 05b101a6a08274a401af88e6d284749038d400a2
Author: Marius Stanciu <stanciumarius94 gmail com>
Date:   Sun Aug 7 17:05:15 2016 +0300

    Add descriptive comment on path layer rendering.

 champlain/champlain-path-layer.c |   19 ++++++++++++++++---
 1 files changed, 16 insertions(+), 3 deletions(-)
---
diff --git a/champlain/champlain-path-layer.c b/champlain/champlain-path-layer.c
index 6cddd87..72cc613 100644
--- a/champlain/champlain-path-layer.c
+++ b/champlain/champlain-path-layer.c
@@ -89,13 +89,26 @@ struct _ChamplainPathLayerPrivate
   
   cairo_surface_t *surface;
 
-  ClutterContent *right_canvas;
-  ClutterContent *left_canvas;
+  /* In order to correctly render paths in the horizontal wrap,
+   * the path_actor (a map-wide actor) contains two children that
+   * split the visible paths.
+   *
+   * The right_actor renders paths visible on the original map layer.
+   * (from viewport's x coordinate to the rightmost point on the map)
+
+   * The left_actor renders paths visible on the first cloned map layer.
+   * (a fixed size, from the leftmost point on the map)
+   *
+   * If horizontal wrap is disabled, the left_actor won't render
+   * anything.
+   */
+  ClutterActor *path_actor;
 
   ClutterActor *right_actor;
   ClutterActor *left_actor;
 
-  ClutterActor *path_actor;
+  ClutterContent *right_canvas;
+  ClutterContent *left_canvas;
 
   GList *nodes;
   gboolean redraw_scheduled;