From 803ac4a4126130626de5ab174ada3b5517f9967d Mon Sep 17 00:00:00 2001 From: Carl Eastlund Date: Tue, 11 Jan 2011 17:54:44 -0500 Subject: [PATCH] Added a sample package to test Planet scribblings. No automated tests yet. Currently one just has to build the package and "eyeball" its documentation. --- .../examples/scribblings-package/doc.scrbl | 69 +++++++++++++++++++ .../examples/scribblings-package/info.rkt | 4 ++ .../scribblings-package/lang-four.rkt | 3 + .../examples/scribblings-package/lang-mod.rkt | 3 + .../examples/scribblings-package/lang-one.rkt | 3 + .../scribblings-package/lang-three.rkt | 3 + .../examples/scribblings-package/lang-two.rkt | 3 + .../examples/scribblings-package/lib.rkt | 3 + .../examples/scribblings-package/main.rkt | 3 + .../scribblings-package/reader-four.rkt | 3 + .../scribblings-package/reader-mod.rkt | 3 + .../scribblings-package/reader-one.rkt | 3 + .../scribblings-package/reader-three.rkt | 3 + .../scribblings-package/reader-two.rkt | 3 + .../scribblings-package/require-four.rkt | 3 + .../scribblings-package/require-mod.rkt | 3 + .../scribblings-package/require-one.rkt | 3 + .../scribblings-package/require-three.rkt | 3 + .../scribblings-package/require-two.rkt | 3 + 19 files changed, 124 insertions(+) create mode 100644 collects/tests/planet/examples/scribblings-package/doc.scrbl create mode 100644 collects/tests/planet/examples/scribblings-package/info.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/lang-four.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/lang-mod.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/lang-one.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/lang-three.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/lang-two.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/lib.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/main.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/reader-four.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/reader-mod.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/reader-one.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/reader-three.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/reader-two.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/require-four.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/require-mod.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/require-one.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/require-three.rkt create mode 100644 collects/tests/planet/examples/scribblings-package/require-two.rkt diff --git a/collects/tests/planet/examples/scribblings-package/doc.scrbl b/collects/tests/planet/examples/scribblings-package/doc.scrbl new file mode 100644 index 0000000000..c662f783ce --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/doc.scrbl @@ -0,0 +1,69 @@ +#lang scribble/manual + +@(require + planet/version + planet/scribble + (for-label + racket/base + (this-package-in + require-mod require-one require-two require-three require-four + lang-mod lang-one lang-two lang-three lang-four + reader-mod reader-one reader-two reader-three reader-four + lib main))) + +@title{Sample Planet Package: @racket[#,(this-package-version-symbol)]} + +@declare-exporting/this-package[lib main] +@defmodule*/no-declare/this-package[(lib main)] + +@racketmod/this-package[ +main +(code:comment "Uh oh, no bindings!") +] + +Here we document @racketmodname/this-package[lib], which is also the +@racketmodlink/this-package[main]{main library} of this package. + +@defthing[x any/c]{Solve for @racket[x].} + +@section{Require} + +@subsection[#:tag-prefix "require"]{One} +@defmodule/this-package[require-mod] +@;(@defthing[x any/c]{Solve for @racket[x].}) + +@subsection[#:tag-prefix "require"]{Many} +@defmodule*/this-package[(require-one require-two)] +@;(@defthing[x any/c]{Solve for @racket[x].}) + +@subsection[#:tag-prefix "require"]{None} +@defmodule*/no-declare/this-package[(require-three require-four)] +@;(@defthing[x any/c]{Solve for @racket[x].}) + +@section{Lang} + +@subsection[#:tag-prefix "lang"]{One} +@defmodulelang/this-package[lang-mod] +@;(@defthing[x any/c]{Solve for @racket[x].}) + +@subsection[#:tag-prefix "lang"]{Many} +@defmodulelang*/this-package[(lang-one lang-two)] +@;(@defthing[x any/c]{Solve for @racket[x].}) + +@subsection[#:tag-prefix "lang"]{None} +@defmodulelang*/no-declare/this-package[(lang-three lang-four)] +@;(@defthing[x any/c]{Solve for @racket[x].}) + +@section{Reader} + +@subsection[#:tag-prefix "reader"]{One} +@defmodulereader/this-package[reader-mod] +@;(@defthing[x any/c]{Solve for @racket[x].}) + +@subsection[#:tag-prefix "reader"]{Many} +@defmodulereader*/this-package[(reader-one reader-two)] +@;(@defthing[x any/c]{Solve for @racket[x].}) + +@subsection[#:tag-prefix "reader"]{None} +@defmodulereader*/no-declare/this-package[(reader-three reader-four)] +@;(@defthing[x any/c]{Solve for @racket[x].}) diff --git a/collects/tests/planet/examples/scribblings-package/info.rkt b/collects/tests/planet/examples/scribblings-package/info.rkt new file mode 100644 index 0000000000..ec73b919da --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/info.rkt @@ -0,0 +1,4 @@ +#lang setup/infotab + +(define name "Sample Package") +(define scribblings '(("doc.scrbl"))) diff --git a/collects/tests/planet/examples/scribblings-package/lang-four.rkt b/collects/tests/planet/examples/scribblings-package/lang-four.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/lang-four.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/lang-mod.rkt b/collects/tests/planet/examples/scribblings-package/lang-mod.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/lang-mod.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/lang-one.rkt b/collects/tests/planet/examples/scribblings-package/lang-one.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/lang-one.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/lang-three.rkt b/collects/tests/planet/examples/scribblings-package/lang-three.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/lang-three.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/lang-two.rkt b/collects/tests/planet/examples/scribblings-package/lang-two.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/lang-two.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/lib.rkt b/collects/tests/planet/examples/scribblings-package/lib.rkt new file mode 100644 index 0000000000..fa23c7281e --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/lib.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide x) +(define x 1) diff --git a/collects/tests/planet/examples/scribblings-package/main.rkt b/collects/tests/planet/examples/scribblings-package/main.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/main.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/reader-four.rkt b/collects/tests/planet/examples/scribblings-package/reader-four.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/reader-four.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/reader-mod.rkt b/collects/tests/planet/examples/scribblings-package/reader-mod.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/reader-mod.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/reader-one.rkt b/collects/tests/planet/examples/scribblings-package/reader-one.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/reader-one.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/reader-three.rkt b/collects/tests/planet/examples/scribblings-package/reader-three.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/reader-three.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/reader-two.rkt b/collects/tests/planet/examples/scribblings-package/reader-two.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/reader-two.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/require-four.rkt b/collects/tests/planet/examples/scribblings-package/require-four.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/require-four.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/require-mod.rkt b/collects/tests/planet/examples/scribblings-package/require-mod.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/require-mod.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/require-one.rkt b/collects/tests/planet/examples/scribblings-package/require-one.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/require-one.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/require-three.rkt b/collects/tests/planet/examples/scribblings-package/require-three.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/require-three.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt") diff --git a/collects/tests/planet/examples/scribblings-package/require-two.rkt b/collects/tests/planet/examples/scribblings-package/require-two.rkt new file mode 100644 index 0000000000..cfc81bcc2f --- /dev/null +++ b/collects/tests/planet/examples/scribblings-package/require-two.rkt @@ -0,0 +1,3 @@ +#lang racket +(provide (all-from-out "lib.rkt")) +(require "lib.rkt")