Browse files

Javadoc improvement

  • Loading branch information...
1 parent db8da07 commit 6a74ee150e2d3b7942ad3479350ffeb1523b4a54 @skuro committed Mar 5, 2012
Showing with 5 additions and 5 deletions.
  1. +5 −5 src/main/java/spring/surf/webscript/WebScript.java
View
10 src/main/java/spring/surf/webscript/WebScript.java
@@ -10,12 +10,12 @@
*/
public interface WebScript {
/**
- * Runs the WebScript
+ * Runs the WebScript and stores the result by updating and returning the model
*
- * @param inputStream
- * @param writer
- * @param model
- * @return
+ * @param inputStream A stream to the clojure web script sources
+ * @param writer The output writer
+ * @param model The model where to put results
+ * @return The updated model
*/
// TODO better documentation and type safety. Or just migrate everything to pure Clojure
Object run(Object inputStream, Object writer, Object model);

0 comments on commit 6a74ee1

Please sign in to comment.