From 3290bb8e77db167c2be6d037488fd1bfd0e2e91f Mon Sep 17 00:00:00 2001 From: Robby Findler Date: Thu, 5 Nov 2009 14:49:29 +0000 Subject: [PATCH] documnted drscheme:help-desk:help-desk svn: r16557 --- collects/drscheme/tool-lib.ss | 32 ++++++++++++++++++++++ collects/scribblings/tools/help-desk.scrbl | 2 +- 2 files changed, 33 insertions(+), 1 deletion(-) diff --git a/collects/drscheme/tool-lib.ss b/collects/drscheme/tool-lib.ss index 026b3fd573..4c67f43805 100644 --- a/collects/drscheme/tool-lib.ss +++ b/collects/drscheme/tool-lib.ss @@ -457,6 +457,38 @@ all of the names in the tools library, for use defining keybindings }) + +; +; +; +; ;; ;; ;;; ;; +; ;; ;; ;; ;; +; ;; ;; ;; ;; +; ;;;;;; ;;;; ;; ;;;;; ;;;;; ;;;; ;;;; ;; ;; +; ;; ;; ;;; ;; ;; ;; ;; ;; ;;; ;;; ;; ;; ; ;; ; +; ;; ;; ;;;;;; ;; ;; ;; ;;;;;;; ;; ;;;;;; ;;;; ;;;; +; ;; ;; ;; ;; ;; ;; ;;;;;;; ;; ;; ;;;; ;;;;; +; ;; ;; ;;; ; ;; ;; ;; ;; ;; ;;; ; ; ;; ;; ;; +; ;; ;;; ;;;; ;; ;;;;; ;;;;;; ;;;; ;;;; ;; ;;; +; ;; +; ;; +; ;; + + (proc-doc/names + drscheme:help-desk:help-desk + (->* () + ((or/c #f string?) + (or/c #f string? (list/c string? string?))) + any) + (() + ((search-key #f) + (search-context #f))) + @{if @scheme[search-key] is a string, calls @scheme[perform-search] with + @scheme[search-key] and @scheme[search-context]. + + Otherwise, calls @scheme[send-main-page] with no arguments.}) + + ; ; ; diff --git a/collects/scribblings/tools/help-desk.scrbl b/collects/scribblings/tools/help-desk.scrbl index 1ccaa16ef0..9b9843945b 100644 --- a/collects/scribblings/tools/help-desk.scrbl +++ b/collects/scribblings/tools/help-desk.scrbl @@ -1,4 +1,4 @@ #lang scribble/doc -@(require "common.ss") +@(require "common.ss" (for-label help/search)) @(tools-title "help-desk") @(tools-include "help-desk")