From 5dabd9991d641037463c0061595a650d2abb7b6e Mon Sep 17 00:00:00 2001
From: Florian Festi <ffesti@redhat.com>
Date: Tue, 15 Mar 2016 21:29:03 +0100
Subject: [PATCH] Doc strings and text for web interface

---
 bserver.py       | 10 +++++++++-
 drillbox.py      |  2 ++
 folder.py        |  1 +
 magazinefile.py  |  1 +
 silverwarebox.py |  3 +++
 trayinsert.py    |  1 +
 typetray.py      |  1 +
 7 files changed, 18 insertions(+), 1 deletion(-)
diff --git a/bserver.py b/bserver.py
index 1c591c0..04ff163 100755
--- a/bserver.py
+++ b/bserver.py
@@ -76,7 +76,15 @@ class BServer:
         result = ["""<html>
 <head><title>Boxes for Laser Cutters</title></head>
 <body>
-Text
+<h1>boxes.py</h1>
+<p>
+A Python based generator for laser cut boxes and other things.
+</p>
+<p>It features both finished parametrized generators as well as a Python API
+for writing your own scripts. It features finger and (flat) dovetail joints,
+flex cuts, holes and slots for screws and more high level functions.
+</p>
+<p>These are the available generators:</p>
 <ul>
 """ ]
         for name in sorted(self.boxes):
diff --git a/drillbox.py b/drillbox.py
index fd1f2b1..d1d725d 100755
--- a/drillbox.py
+++ b/drillbox.py
@@ -17,6 +17,8 @@
 from boxes import *
 
 class Box(Boxes):
+    """Not yet parametrized box for drills from 1 to 12.5mm
+in 0.5mm steps, 3 holes each size"""
     def __init__(self):
         Boxes.__init__(self)
         self.x, self.y, self.h = 120, 240, 60
diff --git a/folder.py b/folder.py
index 55cfee1..4efff71 100755
--- a/folder.py
+++ b/folder.py
@@ -18,6 +18,7 @@ from boxes import *
 import math
 
 class Folder(Boxes):
+    """Book cover with flex for the spine"""
 
     def __init__(self):
         Boxes.__init__(self)
diff --git a/magazinefile.py b/magazinefile.py
index 36083e0..5119116 100755
--- a/magazinefile.py
+++ b/magazinefile.py
@@ -17,6 +17,7 @@
 from boxes import *
 
 class Box(Boxes):
+    """Open magazine file"""
     def __init__(self):
         Boxes.__init__(self)
         self.buildArgParser("x", "y", "h", "hi")
diff --git a/silverwarebox.py b/silverwarebox.py
index 5283bf9..699d9c6 100755
--- a/silverwarebox.py
+++ b/silverwarebox.py
@@ -17,6 +17,9 @@
 from boxes import Boxes
 
 class Silverware(Boxes):
+    """Not yet parametrized cuttlery stand with carrying grip
+using flex for rounded corners"""
+
     ####################################################################
     ### Parts
     ####################################################################
diff --git a/trayinsert.py b/trayinsert.py
index ad5d5aa..605217e 100755
--- a/trayinsert.py
+++ b/trayinsert.py
@@ -17,6 +17,7 @@
 from boxes import *
 
 class TrayInsert(Boxes):
+    """Tray insert without floor and outer walls - allows only continuous walls"""
     def __init__(self):
         Boxes.__init__(self)
         self.buildArgParser("sx", "sy", "h")
diff --git a/typetray.py b/typetray.py
index 28511ea..e515d74 100755
--- a/typetray.py
+++ b/typetray.py
@@ -17,6 +17,7 @@
 from boxes import *
 
 class TypeTray(Boxes):
+    """Type tray - allows only continuous walls"""
     def __init__(self):
         Boxes.__init__(self)
         self.buildArgParser("sx", "sy", "h", "hi")
