Permalink
Browse files

Automatic docs update.

  • Loading branch information...
1 parent 8d99608 commit 075068e778c856701ec5d7cda40f62123058fc28 @brainshave committed Jun 29, 2011
Showing with 68 additions and 3 deletions.
  1. +42 −0 guiftw.swing-api.html
  2. +19 −2 index.clj
  3. +7 −1 index.html
View
@@ -63,6 +63,12 @@ <h1 class="nopad">Table of Contents</h1>
<a href="#guiftw.swing/swing-quirks">swing-quirks</a>
</div>
<br />
+ </div><div style="margin-left: 1em;" class="toc-section">
+ <a href="#guiftw.swing.canvas">guiftw.swing.canvas</a>
+ <div style="margin-left: 1em;" class="toc-entry">
+ <a href="#guiftw.swing.canvas/gen-canvas">gen-canvas</a>
+ </div>
+ <br />
</div>
</div>
</div>
@@ -162,6 +168,42 @@ <h2 id="guiftw.swing/swing-quirks">swing-quirks</h2>
</div>
+<h2 id="namespace-name">guiftw.swing.canvas</h2>
+<pre id="namespace-docstr">Contains gen-canvas macro that can make paintable canvas from any
+class. One class (Canvas) is generated for general use.
+
+When compiling, generates CanvasEvent class (with getGraphics method
+to get Graphics object) representing painting event and
+CanvasListener interface with paint method to implement in order to
+do drawing.</pre>
+
+
+<br />
+<div id="var-entry">
+ <hr />
+ <h2 id="guiftw.swing.canvas/gen-canvas">gen-canvas</h2>
+ <span id="var-type">macro</span><br />
+ <pre id="var-usage">Usage: (gen-canvas superclass new-class)
+</pre>
+ <pre id="var-docstr">Generate a class that handles drawing using a list of
+CanvasListeners. Overwrites paintComponent method and adds these
+methods:
+- addCanvasListener(CanvasListener listener)
+- removeCanvasListener(CanvasListener listener)
+- getCanvasListeners()
+
+Usage of such new class will be like:
+
+(swing [ClassName [:canvas+paint (fn [state event]
+ (.drawSmth (.getGraphics event)))]])
+
+Notes:
+1. new-class must be fully-qualified.
+2. Works only during compilation (like gen-class).</pre>
+
+
+
+</div>
</div>
View
@@ -44,7 +44,12 @@
{:source-url nil,
:wiki-url "guiftw.utils-api.html",
:name "guiftw.utils",
- :doc nil}),
+ :doc nil}
+ {:source-url nil,
+ :wiki-url "guiftw.swing.canvas-api.html",
+ :name "guiftw.swing.canvas",
+ :doc
+ "Contains gen-canvas macro that can make paintable canvas from any\nclass. One class (Canvas) is generated for general use.\n\nWhen compiling, generates CanvasEvent class (with getGraphics method\nto get Graphics object) representing painting event and\nCanvasListener interface with paint method to implement in order to\ndo drawing."}),
:vars
({:arglists ([spec listener-creator]),
:name "adder",
@@ -420,4 +425,16 @@
"Translates a string in a form of \"nice-property\" to\nniceProperty (traditionally used in Java for method names).",
:var-type "function",
:line 4,
- :file "d:\\Projekty\\GUIFTW\\autodoc\\..\\src\\guiftw\\utils.clj"})}
+ :file "d:\\Projekty\\GUIFTW\\autodoc\\..\\src\\guiftw\\utils.clj"}
+ {:arglists ([superclass new-class]),
+ :name "gen-canvas",
+ :namespace "guiftw.swing.canvas",
+ :source-url nil,
+ :raw-source-url nil,
+ :wiki-url "/guiftw.swing-api.html#guiftw.swing.canvas/gen-canvas",
+ :doc
+ "Generate a class that handles drawing using a list of\nCanvasListeners. Overwrites paintComponent method and adds these\nmethods:\n- addCanvasListener(CanvasListener listener)\n- removeCanvasListener(CanvasListener listener)\n- getCanvasListeners()\n\nUsage of such new class will be like:\n\n(swing [ClassName [:canvas+paint (fn [state event]\n (.drawSmth (.getGraphics event)))]])\n\nNotes:\n1. new-class must be fully-qualified.\n2. Works only during compilation (like gen-class).",
+ :var-type "macro",
+ :line 36,
+ :file
+ "d:\\Projekty\\GUIFTW\\autodoc\\..\\src\\guiftw\\swing\\canvas.clj"})}
View
@@ -202,7 +202,13 @@ <h2 id="guiftw.swing">guiftw.swing</h2>
Public variables and functions:
<span id="var-link"><a href="guiftw.swing-api.html#guiftw.swing/default-adder" id="var-tag">default-adder</a> </span><span id="var-link"><a href="guiftw.swing-api.html#guiftw.swing/lafs" id="var-tag">lafs</a> </span><span id="var-link"><a href="guiftw.swing-api.html#guiftw.swing/set-laf" id="var-tag">set-laf</a> </span><span id="var-link"><a href="guiftw.swing-api.html#guiftw.swing/swing" id="var-tag">swing</a> </span><span id="var-link"><a href="guiftw.swing-api.html#guiftw.swing/swing-create" id="var-tag">swing-create</a> </span><span id="var-link"><a href="guiftw.swing-api.html#guiftw.swing/swing-quirks" id="var-tag">swing-quirks</a> </span><br />
-
+ <span id="subspace"><br />Variables and functions in
+ <span id="name">guiftw.swing.canvas</span>:
+ <span id="sub-var-link">
+ <a href="guiftw.swing-api.html#guiftw.swing.canvas/gen-canvas">gen-canvas</a>
+ </span>
+ <br />
+ </span>
</div><div id="namespace-entry">
<br />
<hr />

0 comments on commit 075068e

Please sign in to comment.