schemedoc problems and suggestions
Chris Gaskett <[email protected]>
| Newsgroups | gmane.lisp.scheme.plt.schematics |
|---|---|
| Message-ID | <[email protected]> |
Dear Schematics developers,
I am having trouble using SchemeDoc 0.2 with DrScheme 205 and WebIt!
20030712 under Windows 2000 (I have not tried other versions).
But first, some suggestions:
1. The README could mention that WebIt! is required. (Noel's Schemedoc
mail of 2003-03-12 does mention this)
2. comment.ss uses the aif macro, which is not included with SchemeDoc.
I have not installed the Schematics SRFI package mentioned in the Noel's
mail of 2003-03-12, but I don't think aif is in the SRFI package either.
(I have the SRFIs that come with DrScheme 205.)
Since aif is only used twice, perhaps it could be replaced with a let,
if construction.
Ok, on to the problem:
(require "schemedoc.ss")
(write-documentation (schemedoc "test-file.scm")
(open-output-file "test-file.html" 'replace))
Runs with no error messages or messages to standard out, and
results in a file "test-file.html" containing only:
<documentation><name>test-file.scm</name><api><definitions><function><name>map</name><form><domain>(map
fn list)</domain><range>list</range></form><contract><domain>((any ->
any) (listof any))</domain><range>(listof
any)</range></contract><example><input>(map (lambda (elt) (add1 elt))
(list 1 2 3))</input><output>(list 2 3 4)</output></example><text>Apply
fn to every element of list, accumulating the results in a list
Which does not contain html information, unlike the example result in
"test-file.scm.html" that comes with SchemeDoc.
Running the tests in all-schemedoc-tests results in:
Failure:
Document with complete function
assert-equal? failed at:
C:\scheme\PLT\collects\schemedoc\styles\html-style-test.ss: 44.6
Inputs: <"<html />\n"> <"<documentation>\n <name>\n
test-file.scm\n </name>\n <api>\n <definitions>\n <function>\n
<name>\n map\n </name>\n <form>\n
<domain>\n (map fn list)\n </domain>\n
<...>
Failure:
Document with one function
assert-equal? failed at:
C:\scheme\PLT\collects\schemedoc\styles\html-style-test.ss: 44.6
Inputs: <"<html>\n <head>\n <title>\n dummy.txt\n
</title>\n <link rel=\"stylesheet\" type=\"text/css\"
href=\"style.css\" />\n </head>\n <body>\n <h1 class=\"title\"
align=\"center\">\n dummy.txt\n </h1>\n <div>\n
<div>...> <"<documentation>\n <name>\n dummy.txt\n </name>\n
<api>\n <definitions>\n <function>\n <name>\n
foo\n </name>\n <contract>\n <domain>\n
(foo number number)\n </domain>\n ...>
Failure:
Minimal document
assert-equal? failed at:
C:\scheme\PLT\collects\schemedoc\styles\html-style-test.ss: 44.6
Inputs: <"<html>\n <head>\n <title>\n Title\n </title>\n
<link rel=\"stylesheet\" type=\"text/css\" href=\"style.css\" />\n
</head>\n <body>\n <h1 class=\"title\" align=\"center\">\n
Title\n </h1>\n <div>\n <h2>\n ...> <"<documentation>\n
<name>\n Test\n </name>\n <api>\n <module>\n Module\n
</module>\n <definitions />\n </api>\n</documentation>\n">
Failure:
Empty documentation
assert-equal? failed at:
C:\scheme\PLT\collects\schemedoc\preprocessor-test.ss: 42.6
Inputs: <"<documentation>\n <name>\n dummy.txt\n </name>\n
<api>\n <definitions />\n </api>\n</documentation>\n">
<"<documentation>\n <name>\n dummy.txt\n </name>\n <api
/>\n</documentation>\n">
34 success(es) 0 error(s) 4 failure(s)
I apologise if I missed something obvious.
By the way, SchemeUnit 1.5 is working great for me, thanks!
Chris Gaskett
--
Chris Gaskett
[email protected]
http://www.cns.atr.co.jp/~cgaskett/
OpenPGP key: http://www.cns.atr.co.jp/~cgaskett/Chris_Gaskett.asc
OpenPGP fingerprint: 297B B4BA D297 4252 F6C6 FA74 76D2 4293 022F 0955
-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
SourceForge.net hosts over 70,000 Open Source Projects.
See the people who have HELPED US provide better services:
Click here: http://sourceforge.net/supporters.php