From a42d568c922bb58b46f852b6d1fc17803a21f7c2 Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Sun, 30 Dec 2007 12:48:44 +0000 Subject: [PATCH] fix up web-server docs enough to avoid some warnings svn: r8162 --- collects/web-server/docs/reference/lang.scrbl | 38 +++++++++++++++---- .../web-server/docs/reference/private.scrbl | 16 ++------ .../web-server/docs/reference/servlet.scrbl | 12 ++++-- 3 files changed, 43 insertions(+), 23 deletions(-) diff --git a/collects/web-server/docs/reference/lang.scrbl b/collects/web-server/docs/reference/lang.scrbl index 53d7c3c3c4..a05b268f92 100644 --- a/collects/web-server/docs/reference/lang.scrbl +++ b/collects/web-server/docs/reference/lang.scrbl @@ -178,10 +178,19 @@ In the future, we will offer the facilities to: @section[#:tag "lang/web-extras.ss"]{Web Extras} @require[(for-label web-server/lang/web-extras)] -@filepath{lang/web-extras.ss} provides @scheme[send/suspend/dispatch] and -@scheme[redirect/get] as @secref["web.ss"], except they use -@scheme[embed-proc/url] + @scheme[extract-proc/url] and -@scheme[send/suspend/url] respectively. +@defmodule[web-server/lang/web-extras]{The +@schememodname[web-server/lang/web-extras] library provides +@scheme[send/suspend/dispatch] and @scheme[redirect/get] as +@schememodname[web-server/servlet/web], except they use +@scheme[embed-proc/url] plus @scheme[extract-proc/url] and +@scheme[send/suspend/url], respectively.} + +@deftogether[( +@defform[(send/suspend/dispatch response-proc-expr)] +@defproc[(redirect/get) request?] +)]{ + +See @schememodname[web-server/servlet/web].} @; ------------------------------------------------------------ @section[#:tag "lang/file-box.ss"]{File Boxes} @@ -253,6 +262,21 @@ things in the Web Language, they are sensitive to source code modification. @section[#:tag "lang/web-cells.ss"]{Web Cells} @require[(for-label web-server/lang/web-cells)] -@filepath{lang/web-cells.ss} provides the same API as @secref["web-cells.ss"], -but in a way compatible with the Web Language. The one difference is that -@scheme[make-web-cell] is syntax, rather than a function. +@defmodule[web-server/lang/web-cells]{The +@schememodname[web-server/lang/web-cells] library provides the same +API as @schememodname[web-server/servlet/web-cells], but in a way +compatible with the Web Language. The one difference is that +@scheme[make-web-cell] is syntax, rather than a function.} + +@deftogether[( +@defproc[(web-cell? [v any/c]) + boolean?] +@defform[(make-web-cell default-expr)] +@defproc[(web-cell-ref [wc web-cell?]) + any/c] +@defproc[(web-cell-shadow [wc web-cell?] + [v any/c]) + void] +)]{ + +See @schememodname[web-server/servlet/web-cells].} diff --git a/collects/web-server/docs/reference/private.scrbl b/collects/web-server/docs/reference/private.scrbl index 4d9dfbcc2a..a3bbe34b50 100644 --- a/collects/web-server/docs/reference/private.scrbl +++ b/collects/web-server/docs/reference/private.scrbl @@ -108,6 +108,7 @@ for doing this. @section[#:tag "dispatch-server-unit.ss"]{Dispatching Server} @require[(for-label web-server/private/dispatch-server-unit)] @require[(for-label web-server/private/dispatch-server-sig)] +@require[(for-label web-server/web-server-sig)] The @web-server is just a configuration of a dispatching server. This dispatching server component is useful on its own. @@ -116,20 +117,11 @@ This dispatching server component is useful on its own. @defmodule[web-server/private/dispatch-server-sig] -The @schememodname[web-server/private/dispatch-server-sig] module +The @schememodname[web-server/private/dispatch-server-sig] library provides two signatures. -@defsignature[dispatch-server^ ()]{ - @defproc[(serve) - (-> void)]{ - Runs and returns a shutdown procedure. - } - @defproc[(serve-ports [i input-port?] - [o output-port?]) - void]{ - Serves a single connection with @scheme[i] and @scheme[o]. - } -} +The @scheme[dispatch-server^] signature is an alias for +@scheme[web-server^]. @defsignature[dispatch-server-config^ ()]{ diff --git a/collects/web-server/docs/reference/servlet.scrbl b/collects/web-server/docs/reference/servlet.scrbl index 829933672d..e0544f3a45 100644 --- a/collects/web-server/docs/reference/servlet.scrbl +++ b/collects/web-server/docs/reference/servlet.scrbl @@ -218,8 +218,9 @@ transmission that the server will not catch.} @section[#:tag "web.ss"]{Web} @require[(for-label web-server/servlet/web)] -@filepath{servlet/web.ss} provides the primary functions of interest for the -servlet developer. +@defmodule[web-server/servlet/web]{The +@schememodname[web-server/servlet/web] library provides the primary +functions of interest for the servlet developer.} @defproc[(send/back [response response?]) void?]{ @@ -369,7 +370,9 @@ implementation of HTTP Basic Authentication. @section[#:tag "web-cells.ss"]{Web Cells} @require[(for-label web-server/servlet/web-cells)] -@filepath{servlet/web-cells.ss} provides the interface to web cells. +@defmodule[web-server/servlet/web-cells]{The +@schememodname[web-server/servlet/web-cells] library provides the +interface to web cells.} A web cell is a kind of state defined relative to the @defterm{frame tree}. The frame-tree is a mirror of the user's browsing session. Every time a @@ -378,7 +381,8 @@ created as a child of the current frame when the continuation was captured. You should use web cells if you want an effect to be encapsulated in all interactions linked from (in a transitive sense) the HTTP response being -generated. For more information on their semantics, consult the paper @href-link["http://www.cs.brown.edu/~sk/Publications/Papers/Published/mk-int-safe-state-web/" +generated. For more information on their semantics, consult the paper +@href-link["http://www.cs.brown.edu/~sk/Publications/Papers/Published/mk-int-safe-state-web/" "\"Interaction-Safe State for the Web\""]. @; XXX Document with-frame and with-frame-after?