From ccdad98be2cdd27a458df1bbee745ee83a8949e7 Mon Sep 17 00:00:00 2001
From: Ian Jackson <ian@liberator.relativity.greenend.org.uk>
Date: Sat, 6 Nov 2010 16:21:34 +0000
Subject: [PATCH] layout: add some divvying comments to source code

---
 layout/layout | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/layout/layout b/layout/layout
index 9fc7ea9..3a5e4c1 100755
--- a/layout/layout
+++ b/layout/layout
@@ -440,6 +440,8 @@ sub v_dist ($$) {
     return v_len(v_subtract($_[0],$_[1]));
 }
 
+#---------- utility functions ----------
+
 sub upd_min ($$) {
     my ($limr,$now)=@_;
     $$limr= $now unless defined $$limr && $$limr <= $now;
@@ -630,6 +632,8 @@ sub dv {
     }
 }		    
 
+#---------- output helpers ----------
+
 sub o ($) { $o .= $_[0]; }
 sub ol ($) { $ol .= $_[0]; }
 sub oflushpage () {
@@ -682,6 +686,8 @@ sub current_draw () {
     $r;
 }
 
+#---------- parametric segments ----------
+
 sub psu_coords ($$$) {
     my ($ends,$inunit,$across)=@_;
     # $ends->[0]{X} etc.; $inunit 0 to 1 (but go to 1.5);
@@ -957,6 +963,8 @@ print DEBUG "ps $p0 $p1 $lenperp ($ppu) $allwidth\n";
     }    
 }
 
+#---------- commands for segments and their helpers ----------
+
 sub arc ($$$$$) {
     my ($to, $ctr,$from, $radius,$delta) = @_;
     # does parametric_segment to draw an arc centred on $ctr
@@ -1274,6 +1282,8 @@ sub cmd_extend {
     printf DEBUG "to $to->{X} $to->{Y} $to->{A}\n";
 }
 
+#---------- other commands ----------
+
 sub loc2dbg ($) {
     my ($loc) = @_;
     return "$loc->{X} $loc->{Y} ".ang2deg($loc->{A});
@@ -1520,6 +1530,8 @@ sub cmd_layer {
     $ctx->{Draw}= layer_draw($k,$l);
 }    
 
+#---------- commands for parts and object ----------
+
 sub cmd_part { cmd__obj(Part); }
 sub cmd_obj { cmd__obj(1); }
 sub cmd_objflip { cmd__obj(-1); }
@@ -1758,6 +1770,8 @@ sub cmd__one {
     cmd__do();
 }
 
+#---------- main program ----------
+
 o("%!\n".
   "  /lf /Courier-New findfont $lmu_marktpt scalefont def\n".
   "  /sf /Courier-Bold findfont $lmu_segtpt scalefont def\n".
-- 
2.30.2