unstable: added consistent doc headers

svn: r17390
This commit is contained in:
Ryan Culpepper 2009-12-23 05:07:59 +00:00
parent 2e5e66486d
commit 7a32bda7c9
11 changed files with 37 additions and 11 deletions

View File

@ -1,6 +1,7 @@
#lang scribble/doc
@(require scribble/base
scribble/manual
"utils.ss"
(for-label unstable/bytes
scheme/serialize
scheme/contract
@ -10,6 +11,8 @@
@defmodule[unstable/bytes]
@unstable-header[]
@defproc[(bytes-ci=? [b1 bytes?] [b2 bytes?]) boolean?]{
Compares two bytes case insensitively.
}

View File

@ -10,6 +10,8 @@
@defmodule[unstable/contract]
@unstable-header[]
@defthing[non-empty-string/c contract?]{
Contract for non-empty strings.
}

View File

@ -1,6 +1,7 @@
#lang scribble/doc
@(require scribble/base
scribble/manual
"utils.ss"
(for-label unstable/exn
scheme/contract
scheme/base))
@ -9,6 +10,8 @@
@defmodule[unstable/exn]
@unstable-header[]
@defproc[(network-error [s symbol?]
[fmt string?]
[v any/c] ...)

View File

@ -16,6 +16,8 @@
@defmodule[unstable/list]
@unstable-header[]
@defproc[(list-prefix? [l list?]
[r list?])
boolean?]{

View File

@ -1,5 +1,6 @@
#lang scribble/manual
@(require scribble/eval
"utils.ss"
(for-label unstable/mutated-vars
scheme/contract
scheme/base))
@ -11,7 +12,7 @@
@defmodule[unstable/mutated-vars]
@author[@author+email["Sam Tobin-Hochstadt" "samth@ccs.neu.edu"]]
@unstable[@author+email["Sam Tobin-Hochstadt" "samth@ccs.neu.edu"]]
@defproc[(find-mutated-vars [stx syntax?]) void?]{ Traverses

View File

@ -1,11 +1,14 @@
#lang scribble/doc
@(require scribble/base
scribble/manual)
scribble/manual
"utils.ss")
@title[#:tag "net" #:style 'toc]{Net}
@defmodule[unstable/net]
@unstable-header[]
@local-table-of-contents[]
@include-section["net/url.scrbl"]

View File

@ -1,6 +1,7 @@
#lang scribble/doc
@(require scribble/base
scribble/manual
"../utils.ss"
(for-label unstable/net/url
net/url
scheme/contract
@ -10,6 +11,8 @@
@defmodule[unstable/net/url]
@unstable-header[]
@defproc[(url-replace-path [proc ((listof path/param?) . -> . (listof path/param?))]
[u url?])
url?]{

View File

@ -1,6 +1,7 @@
#lang scribble/doc
@(require scribble/base
scribble/manual
"utils.ss"
(for-label unstable/path
unstable/contract
scheme/contract
@ -10,6 +11,8 @@
@defmodule[unstable/path]
@unstable-header[]
@defproc[(explode-path* [p path-string?])
(listof path-element?)]{
Like @scheme[normalize-path], but does not resolve symlinks.

View File

@ -1,5 +1,6 @@
#lang scribble/manual
@(require scribble/eval
"utils.ss"
(for-label unstable/poly-c
scheme/contract
scheme/base))
@ -11,8 +12,8 @@
@defmodule[unstable/poly-c]
@author[@author+email["Sam Tobin-Hochstadt" "samth@ccs.neu.edu"]
@author+email["Carl Eastlund" "cce@ccs.neu.edu"]]
@unstable[@author+email["Sam Tobin-Hochstadt" "samth@ccs.neu.edu"]
@author+email["Carl Eastlund" "cce@ccs.neu.edu"]]
@defform[(poly/c ([id+ id-] ...) cnt)]{

View File

@ -1,6 +1,7 @@
#lang scribble/doc
@(require scribble/base
scribble/manual
"utils.ss"
(for-label unstable/string
scheme/serialize
scheme/contract
@ -10,6 +11,8 @@
@defmodule[unstable/string]
@unstable-header[]
@defproc[(lowercase-symbol! [sb (or/c string? bytes?)])
symbol?]{
Returns @scheme[sb] as a lowercase symbol.

View File

@ -1,17 +1,19 @@
#lang at-exp scheme/base
(require scribble/base scribble/manual scribble/core)
(provide unstable
unstable-header
addition)
(provide unstable addition)
(define (unstable . authors)
(make-compound-paragraph
plain
(list (apply author authors)
@para{This library is @emph{unstable};
compatibility will not be maintained.
See @secref{unstable} for more information.})))
(unstable-header))))
(define (unstable-header)
@para{This library is @emph{unstable};
compatibility will not be maintained.
See @secref{unstable} for more information.})
(define (addition name)
@margin-note{The subsequent bindings were added by @|name|.})