moved all of the framework's function documentation into the scribble/srcdoc world

svn: r9545

original commit: 3eb20f5a11269e7f1948c67c655efedab0766dd7
This commit is contained in:
Robby Findler 2008-04-30 19:18:52 +00:00
parent cea170dadd
commit a3e4f252df
33 changed files with 1656 additions and 147 deletions

File diff suppressed because it is too large Load Diff

View File

@ -300,52 +300,6 @@ the state transitions / contracts are:
(provide/doc (provide/doc
(proc-doc/names
preferences:snapshot?
(-> any/c boolean?)
(arg)
@{Determines if its argument is a preferences snapshot.
See also
@scheme[preferences:get-prefs-snapshot] and
@scheme[preferences:restore-prefs-snapshot].})
(proc-doc/names
preferences:restore-prefs-snapshot
(-> preferences:snapshot? void?)
(snapshot)
@{Restores the preferences saved in @scheme[snapshot].
See also @scheme[preferences:get-prefs-snapshot].})
(proc-doc/names
preferences:get-prefs-snapshot
(-> preferences:snapshot?)
()
@{Caches all of the current values of the preferences and returns them.
See also
@scheme[preferences:restore-prefs-snapshot].})
(proc-doc/names
exn:make-unknown-preference
(string? continuation-mark-set? . -> . exn:unknown-preference?)
(message continuation-marks)
@{Creates an unknown preference exception.})
(proc-doc/names
exn:unknown-preference?
(any/c . -> . boolean?)
(exn)
@{Determines if a value is an unknown preference exn.})
(parameter-doc
preferences:low-level-put-preferences
(parameter/c (-> (listof symbol?) (listof any/c) any))
put-preference
@{This parameter's value
is called when to save preference the preferences. Its interface should
be just like mzlib's @scheme[put-preference].})
(proc-doc/names (proc-doc/names
preferences:get preferences:get
(symbol? . -> . any/c) (symbol? . -> . any/c)
@ -355,8 +309,8 @@ the state transitions / contracts are:
@scheme[preferences:get] returns the value for the preference @scheme[preferences:get] returns the value for the preference
@scheme[symbol]. It raises @scheme[symbol]. It raises
@index['("exn:unknown-preference")]{@scheme[exn:unknown-preference]} @index['("exn:unknown-preference")]{@scheme[exn:unknown-preference]}
@scheme[exn:unknown-preference]
if the preference's default has not been set.}) if the preference's default has not been set.})
(proc-doc/names (proc-doc/names
preferences:set preferences:set
(symbol? any/c . -> . void?) (symbol? any/c . -> . void?)
@ -372,6 +326,7 @@ the state transitions / contracts are:
It raises It raises
@index['("exn:unknown-preference")]{@scheme[exn:unknown-preference]} @index['("exn:unknown-preference")]{@scheme[exn:unknown-preference]}
if the preference's default has not been set.}) if the preference's default has not been set.})
(proc-doc/names (proc-doc/names
preferences:add-callback preferences:add-callback
(->* (symbol? (->* (symbol?
@ -461,4 +416,52 @@ the state transitions / contracts are:
() ()
@{@scheme[(preferences:restore-defaults)] @{@scheme[(preferences:restore-defaults)]
restores the users's configuration to the restores the users's configuration to the
default preferences.})) default preferences.})
(proc-doc/names
exn:make-unknown-preference
(string? continuation-mark-set? . -> . exn:unknown-preference?)
(message continuation-marks)
@{Creates an unknown preference exception.})
(proc-doc/names
exn:unknown-preference?
(any/c . -> . boolean?)
(exn)
@{Determines if a value is an unknown preference exn.})
(parameter-doc
preferences:low-level-put-preferences
(parameter/c (-> (listof symbol?) (listof any/c) any))
put-preference
@{This parameter's value
is called when to save preference the preferences. Its interface should
be just like mzlib's @scheme[put-preference].})
(proc-doc/names
preferences:snapshot?
(-> any/c boolean?)
(arg)
@{Determines if its argument is a preferences snapshot.
See also
@scheme[preferences:get-prefs-snapshot] and
@scheme[preferences:restore-prefs-snapshot].})
(proc-doc/names
preferences:restore-prefs-snapshot
(-> preferences:snapshot? void?)
(snapshot)
@{Restores the preferences saved in @scheme[snapshot].
See also @scheme[preferences:get-prefs-snapshot].})
(proc-doc/names
preferences:get-prefs-snapshot
(-> preferences:snapshot?)
()
@{Caches all of the current values of the preferences and returns them.
See also
@scheme[preferences:restore-prefs-snapshot].}))

View File

@ -0,0 +1,16 @@
#lang scheme/base
(provide mapdesc)
(require (for-syntax scheme/base)
scribble/decode
scribble/manual)
(define-syntax (mapdesc stx)
(syntax-case stx ()
[(_ cmd events)
#'(make-splice (list (index (symbol->string 'cmd))
(symbol->string 'cmd)
" ("
(symbol->string 'events)
" events)"))]))

View File

@ -1,8 +1,8 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Application} @title{Application}
@(require framework/framework-docs)
@(def-fw-procs application) @(include-extracted (lib "main.ss" "framework") #rx"^application:")

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Autosave} @title{Autosave}
@ -14,5 +14,5 @@
} }
} }
@(require framework/framework-docs)
@(def-fw-procs autosave) @(include-extracted (lib "main.ss" "framework") #rx"^autosave:")

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Canvas} @title{Canvas}
@ -98,5 +98,5 @@
@defclass[canvas:info% (canvas:info-mixin canvas:basic%) ()]{} @defclass[canvas:info% (canvas:info-mixin canvas:basic%) ()]{}
@defclass[canvas:delegate% (canvas:delegate-mixin canvas:basic%) ()]{} @defclass[canvas:delegate% (canvas:delegate-mixin canvas:basic%) ()]{}
@defclass[canvas:wide-snip% (canvas:wide-snip-mixin canvas:basic%) ()]{} @defclass[canvas:wide-snip% (canvas:wide-snip-mixin canvas:basic%) ()]{}
@(require framework/framework-docs)
@(def-fw-procs canvas) @(include-extracted (lib "main.ss" "framework") #rx"^canvas:")

View File

@ -1,8 +1,8 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Color Model} @title{Color Model}
@(require framework/framework-docs)
@(def-fw-procs color-model) @(include-extracted (lib "main.ss" "framework") #rx"^color-model:")

View File

@ -1,8 +1,8 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Color Prefs} @title{Color Prefs}
@(require framework/framework-docs)
@(def-fw-procs color-prefs) @(include-extracted (lib "main.ss" "framework") #rx"^color-prefs:")

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Color} @title{Color}
@ -231,5 +231,5 @@
} }
} }
@defclass[color:text-mode% (color:text-mode-mixin mode:surrogate-text%) ()]{} @defclass[color:text-mode% (color:text-mode-mixin mode:surrogate-text%) ()]{}
@(require framework/framework-docs)
@(def-fw-procs color) @(include-extracted (lib "main.ss" "framework") #rx"^color:")

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Comment Box} @title{Comment Box}
@ -44,5 +44,5 @@
} }
} }
@(require framework/framework-docs)
@(def-fw-procs comment-box) @(include-extracted (lib "main.ss" "framework") #rx"^comment-box:")

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Editor} @title{Editor}
@ -428,5 +428,5 @@
@method[frame:info<%> lock-status-changed]. @method[frame:info<%> lock-status-changed].
} }
} }
@(require framework/framework-docs)
@(def-fw-procs editor) @(include-extracted (lib "main.ss" "framework") #rx"^editor:")

View File

@ -1,8 +1,8 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Exit} @title{Exit}
@(require framework/framework-docs)
@(def-fw-procs exit) @(include-extracted (lib "main.ss" "framework") #rx"^exit:")

View File

@ -1,8 +1,8 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Finder} @title{Finder}
@(require framework/framework-docs)
@(def-fw-procs finder) @(include-extracted (lib "main.ss" "framework") #rx"^finder:")

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Frame} @title{Frame}
@ -2380,5 +2380,5 @@
@defclass[frame:searchable% (frame:searchable-text-mixin (frame:searchable-mixin frame:text%)) ()]{} @defclass[frame:searchable% (frame:searchable-text-mixin (frame:searchable-mixin frame:text%)) ()]{}
@defclass[frame:delegate% (frame:delegate-mixin frame:searchable%) ()]{} @defclass[frame:delegate% (frame:delegate-mixin frame:searchable%) ()]{}
@defclass[frame:pasteboard% (frame:pasteboard-mixin frame:open-here%) ()]{} @defclass[frame:pasteboard% (frame:pasteboard-mixin frame:open-here%) ()]{}
@(require framework/framework-docs)
@(def-fw-procs frame) @(include-extracted (lib "main.ss" "framework") #rx"^frame:")

View File

@ -2,17 +2,15 @@
@(require (for-label framework scheme/gui)) @(require (for-label framework scheme/gui))
@(require scribble/manual) @(require scribble/manual)
@(defmodule framework)
@title{@bold{Framework}: PLT GUI Application Framework} @title{@bold{Framework}: PLT GUI Application Framework}
@(defmodule framework)
@bold{TODO:} @bold{TODO:}
@itemize{ @itemize{
@item{Mode} @item{Mode}
@item{``Cannot parse docs for handler:open-file''}
@item{Check indexing in preferences:get} @item{Check indexing in preferences:get}
@item{Warnings in the translation process} @item{Warnings in the translation process}
@item{Get rid of framework-exports.ss}
} }
------------------------------------------------------------------------------------------ ------------------------------------------------------------------------------------------
@ -97,7 +95,6 @@ Johnathan Franklin, Mark Krentel, Corky Cartwright, Michael
Ernst, Kennis Koldewyn, Bruce Duba, and many others for Ernst, Kennis Koldewyn, Bruce Duba, and many others for
their feedback and help. their feedback and help.
@include-section["tmp.scrbl"]
@include-section["application.scrbl"] @include-section["application.scrbl"]
@include-section["autosave.scrbl"] @include-section["autosave.scrbl"]
@include-section["canvas.scrbl"] @include-section["canvas.scrbl"]

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Group} @title{Group}
@ -120,5 +120,5 @@
} }
} }
@(require framework/framework-docs)
@(def-fw-procs group) @(include-extracted (lib "main.ss" "framework") #rx"^group:")

View File

@ -3,8 +3,5 @@
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{GUI Utilities} @title{GUI Utilities}
@(require framework/framework-docs)
@(defmodule framework/gui-utils) @(defmodule framework/gui-utils)
@(include-extracted (lib "gui-utils.ss" "framework")) @(include-extracted (lib "gui-utils.ss" "framework"))

View File

@ -1,8 +1,8 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Handler} @title{Handler}
@(require framework/framework-docs)
@(def-fw-procs handler) @(include-extracted (lib "main.ss" "framework") #rx"^handler:")

View File

@ -1,8 +1,8 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Icon} @title{Icon}
@(require framework/framework-docs)
@(def-fw-procs icon) @(include-extracted (lib "main.ss" "framework") #rx"^icon:")

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Keymap} @title{Keymap}
@ -41,5 +41,5 @@
} }
} }
@defclass[keymap:aug-keymap% (keymap:aug-keymap-mixin keymap%) ()]{} @defclass[keymap:aug-keymap% (keymap:aug-keymap-mixin keymap%) ()]{}
@(require framework/framework-docs)
@(def-fw-procs keymap) @(include-extracted (lib "main.ss" "framework") #rx"^keymap:")

View File

@ -1,8 +1,8 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Main} @title{Main}
@(require framework/framework-docs)
@(def-fw-procs main) @(include-extracted (lib "main.ss" "framework") #rx"^main:")

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Menu} @title{Menu}
@ -44,5 +44,5 @@
@defclass[menu:can-restore-menu-item% (menu:can-restore-mixin menu-item%) ()]{} @defclass[menu:can-restore-menu-item% (menu:can-restore-mixin menu-item%) ()]{}
@defclass[menu:can-restore-checkable-menu-item% (menu:can-restore-mixin checkable-menu-item%) ()]{} @defclass[menu:can-restore-checkable-menu-item% (menu:can-restore-mixin checkable-menu-item%) ()]{}
@defclass[menu:can-restore-underscore-menu% (menu:can-restore-underscore-mixin menu%) ()]{} @defclass[menu:can-restore-underscore-menu% (menu:can-restore-underscore-mixin menu%) ()]{}
@(require framework/framework-docs)
@(def-fw-procs menu) @(include-extracted (lib "main.ss" "framework") #rx"^menu:")

View File

@ -1,8 +1,8 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Mode} @title{Mode}
@(require framework/framework-docs)
@(def-fw-procs mode) @(include-extracted (lib "main.ss" "framework") #rx"^mode:")

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Number Snip} @title{Number Snip}
@ -11,5 +11,5 @@
Constructs a number snip from its input. Constructs a number snip from its input.
} }
} }
@(require framework/framework-docs)
@(def-fw-procs number-snip) @(include-extracted (lib "main.ss" "framework") #rx"^number-snip:")

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Panel} @title{Panel}
@ -167,5 +167,5 @@
} }
@defclass[panel:vertical-dragable% (panel:vertical-dragable-mixin (panel:dragable-mixin vertical-panel%)) ()]{} @defclass[panel:vertical-dragable% (panel:vertical-dragable-mixin (panel:dragable-mixin vertical-panel%)) ()]{}
@defclass[panel:horizontal-dragable% (panel:horizontal-dragable-mixin (panel:dragable-mixin horizontal-panel%)) ()]{} @defclass[panel:horizontal-dragable% (panel:horizontal-dragable-mixin (panel:dragable-mixin horizontal-panel%)) ()]{}
@(require framework/framework-docs)
@(def-fw-procs panel) @(include-extracted (lib "main.ss" "framework") #rx"^panel:")

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Pasteboard} @title{Pasteboard}
@ -10,5 +10,5 @@
@defclass[pasteboard:file% (editor:file-mixin pasteboard:keymap%) ()]{} @defclass[pasteboard:file% (editor:file-mixin pasteboard:keymap%) ()]{}
@defclass[pasteboard:backup-autosave% (editor:backup-autosave-mixin pasteboard:file%) ()]{} @defclass[pasteboard:backup-autosave% (editor:backup-autosave-mixin pasteboard:file%) ()]{}
@defclass[pasteboard:info% (editor:info-mixin pasteboard:backup-autosave%) ()]{} @defclass[pasteboard:info% (editor:info-mixin pasteboard:backup-autosave%) ()]{}
@(require framework/framework-docs)
@(def-fw-procs pasteboard) @(include-extracted (lib "main.ss" "framework") #rx"^pasteboard:")

View File

@ -1,8 +1,8 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Path Utils} @title{Path Utils}
@(require framework/framework-docs)
@(def-fw-procs path-utils) @(include-extracted (lib "main.ss" "framework") #rx"^path-utils:")

View File

@ -4,7 +4,6 @@
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Preferences, Textual} @title{Preferences, Textual}
@(require framework/framework-docs)
@(defmodule framework/preferences) @(defmodule framework/preferences)
@(include-extracted (lib "preferences.ss" "framework")) @(include-extracted (lib "preferences.ss" "framework"))

View File

@ -1,8 +1,8 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Preferences} @title{Preferences}
@(require framework/framework-docs)
@(def-fw-procs preferences) @(include-extracted (lib "main.ss" "framework") #rx"^preferences:")

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Scheme} @title{Scheme}
@ -269,5 +269,5 @@
} }
@defclass[scheme:text% (scheme:set-mode-mixin (scheme:text-mixin (text:autocomplete-mixin (mode:host-text-mixin color:text%)))) ()]{} @defclass[scheme:text% (scheme:set-mode-mixin (scheme:text-mixin (text:autocomplete-mixin (mode:host-text-mixin color:text%)))) ()]{}
@defclass[scheme:text-mode% (scheme:text-mode-mixin color:text-mode%) ()]{} @defclass[scheme:text-mode% (scheme:text-mode-mixin color:text-mode%) ()]{}
@(require framework/framework-docs)
@(def-fw-procs scheme) @(include-extracted (lib "main.ss" "framework") #rx"^scheme:")

View File

@ -4,7 +4,6 @@
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Test} @title{Test}
@(require framework/framework-docs)
@(defmodule framework/test) @(defmodule framework/test)
The framework provides several new primitive functions that simulate The framework provides several new primitive functions that simulate
@ -114,5 +113,4 @@ actual mouse.
@section{Test Functions} @section{Test Functions}
@(def-fw-procs test)
@(include-extracted (lib "test.ss" "framework")) @(include-extracted (lib "test.ss" "framework"))

View File

@ -1,5 +1,5 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Text} @title{Text}
@ -946,5 +946,5 @@
@defclass[text:backup-autosave% (editor:backup-autosave-mixin text:clever-file-format%) ()]{} @defclass[text:backup-autosave% (editor:backup-autosave-mixin text:clever-file-format%) ()]{}
@defclass[text:searching% (text:searching-mixin text:backup-autosave%) ()]{} @defclass[text:searching% (text:searching-mixin text:backup-autosave%) ()]{}
@defclass[text:info% (text:info-mixin (editor:info-mixin text:searching%)) ()]{} @defclass[text:info% (text:info-mixin (editor:info-mixin text:searching%)) ()]{}
@(require framework/framework-docs)
@(def-fw-procs text) @(include-extracted (lib "main.ss" "framework") #rx"^text:")

View File

@ -1,8 +1,8 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual) @(require scribble/manual scribble/extract)
@(require (for-label framework)) @(require (for-label framework))
@(require (for-label scheme/gui)) @(require (for-label scheme/gui))
@title{Version} @title{Version}
@(require framework/framework-docs)
@(def-fw-procs version) @(include-extracted (lib "main.ss" "framework") #rx"^version:")