Skip to content

Commit

Permalink
adding some ns-leve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
daveray committed Jun 9, 2011
1 parent f1298ab commit c7607a0
Show file tree
Hide file tree
Showing 14 changed files with 54 additions and 17 deletions.
4 changes: 3 additions & 1 deletion src/seesaw/action.clj
Expand Up @@ -8,7 +8,9 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.action
(ns ^{:doc "Functions for dealing with Swing Actions. Prefer (seesaw.core/action)."
:author "Dave Ray"}
seesaw.action
(:use [seesaw util icon keystroke meta])
(:import [javax.swing Action AbstractAction]))

Expand Down
5 changes: 4 additions & 1 deletion src/seesaw/applet.clj
Expand Up @@ -8,7 +8,10 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.applet
(ns ^{:doc "Macros and functions that make creating an applet with Seesaw a
little less painful."
:author "Dave Ray"}
seesaw.applet
(:use [seesaw core])
(:import [javax.swing JApplet]))

Expand Down
9 changes: 5 additions & 4 deletions src/seesaw/behave.clj
Expand Up @@ -8,10 +8,11 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.behave
"A collection of basic behaviors that can be dynamically added to widgets.
Most cover basic functionality that's missing from swing or just a pain
to implement."
(ns ^{:doc "A collection of basic behaviors that can be dynamically added to
widgets. Most cover basic functionality that's missing from Swing
or just a pain to implement."
:author "Dave Ray"}
seesaw.behave
(:use [seesaw core util]))

(defn when-focused-select-all
Expand Down
5 changes: 4 additions & 1 deletion src/seesaw/bind.clj
Expand Up @@ -8,7 +8,10 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.bind
(ns ^{:doc "Some functions for binding atoms to various mutable Swing objects
like models."
:author "Dave Ray"}
seesaw.bind
(:use [seesaw.event]))

(defn bind-atom-to-range-model
Expand Down
4 changes: 3 additions & 1 deletion src/seesaw/border.clj
Expand Up @@ -8,7 +8,9 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.border
(ns ^{:doc "Functions for creating widget borders."
:author "Dave Ray"}
seesaw.border
(:use seesaw.color)
(:import [javax.swing BorderFactory]
[javax.swing.border Border]
Expand Down
6 changes: 5 additions & 1 deletion src/seesaw/cells.clj
Expand Up @@ -8,7 +8,11 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.cells
(ns ^{:doc "Functions for implementing custom cell renderers. Note that on
many core functions (listbox, tree, combobox, etc) a render function
can be given directly to the :renderer option."
:author "Dave Ray"}
seesaw.cells
(:use [seesaw util]))

(def ^{:private true} nil-fn (constantly nil))
Expand Down
4 changes: 3 additions & 1 deletion src/seesaw/chooser.clj
Expand Up @@ -8,7 +8,9 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.chooser
(ns ^{:doc "File chooser and other common dialogs."
:author "Dave Ray"}
seesaw.chooser
(:use seesaw.util)
(:import [javax.swing JFileChooser]))

Expand Down
5 changes: 4 additions & 1 deletion src/seesaw/color.clj
Expand Up @@ -8,7 +8,10 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.color
(ns ^{:doc "Functions for creating Swing colors. Note that these are implicit
in the core color options."
:author "Dave Ray"}
seesaw.color
(:import [java.awt Color]))

(defn get-rgba
Expand Down
7 changes: 6 additions & 1 deletion src/seesaw/core.clj
Expand Up @@ -8,7 +8,12 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.core
(ns ^{:doc "Core functions and macros for Seesaw. Although there are many more
Seesaw namespaces, usually what you want is in here. Most functions
in other namespaces have a core wrapper which adds additional
capability or makes them easier to use."
:author "Dave Ray"}
seesaw.core
(:use [seesaw util font border color meta to-widget]
[clojure.string :only (capitalize split)])
(:require [seesaw.invoke]
Expand Down
5 changes: 4 additions & 1 deletion src/seesaw/event.clj
Expand Up @@ -8,7 +8,10 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.event
(ns ^{:doc "Functions for handling events. Do not use these functions directly.
Use (seesaw.core/listen) instead."
:author "Dave Ray"}
seesaw.event
(:use [seesaw util meta])
(:import [javax.swing.event ChangeListener DocumentListener
ListSelectionListener TreeSelectionListener]
Expand Down
5 changes: 4 additions & 1 deletion src/seesaw/font.clj
Expand Up @@ -8,7 +8,10 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.font
(ns ^{:doc "Functions for handling fonts. Note that most core widget functions
use these implicitly through the :font option."
:author "Dave Ray"}
seesaw.font
(:use [seesaw util])
(:import [java.awt Font]))

Expand Down
4 changes: 3 additions & 1 deletion src/seesaw/graphics.clj
Expand Up @@ -8,7 +8,9 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.graphics
(ns ^{:doc "Basic graphics functions to simplify use of Graphics2D."
:author "Dave Ray"}
seesaw.graphics
(:use [seesaw util color font])
(:import [java.awt Graphics2D RenderingHints]
[java.awt.image BufferedImage]))
Expand Down
4 changes: 3 additions & 1 deletion src/seesaw/icon.clj
Expand Up @@ -8,7 +8,9 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.icon
(ns ^{:doc "Functions for loading and creating icons."
:author "Dave Ray"}
seesaw.icon
(:use [seesaw util])
(:import [javax.swing ImageIcon]))

Expand Down
4 changes: 3 additions & 1 deletion src/seesaw/meta.clj
Expand Up @@ -8,7 +8,9 @@
; the terms of this license.
; You must not remove this notice, or any other, from this software.

(ns seesaw.meta
(ns ^{:doc "Functions for associating metadata with frames and widgets, etc."
:author "Dave Ray"}
seesaw.meta
(:import [java.lang.ref WeakReference]))

(defprotocol Meta
Expand Down

0 comments on commit c7607a0

Please sign in to comment.