Add to sound docstrings

2014-01-25 17:49:18 -05:00
parent a91cd1c364
commit fcdfc5d7d6
1 changed files with 6 additions and 2 deletions
--- a/src/play_clj/core_global.clj
+++ b/src/play_clj/core_global.clj
@@ -129,12 +129,16 @@
 (defmacro sound
  "Returns a [Sound](http://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/audio/Sound.html)

-    (sound \"playerhurt.wav\")"
+    (sound \"playerhurt.wav\")
+    (sound \"playerhurt.wav\" :play)"
  [path & options]
  `(u/calls! ^Sound (sound* ~path) ~@options))

 (defmacro sound!
-  "Calls a single method on a `sound`"
+  "Calls a single method on a `sound`
+
+    (sound! object :play)
+    (sound! object :dispose)"
  [object k & options]
  `(let [^Sound object# ~object]
     (u/call! object# ~k ~@options)))