source: project/fpfz/fpfz-eggdoc.scm @ 1226

Last change on this file since 1226 was 1226, checked in by Jim Ursetto, 14 years ago

Modified the following eggdocs for eggdoc-texinfo compatibility.

array-lib: Documentation "sections" changed to subsections. Adjusted example formatting
bloom-filter: Documentation "sections" changed to subsections
box: same as bloom-filter
cookie: Invalid eggdoc
crc: remove dup PRE tag [issue since fixed]
F-operator: section -> subsection; usage -> pre

Not completely fixed -- excess whitespace due to limitation of

info. Recommended fix is to manually collapse whitespace by
closing strings at end of line

fp: signature typo; section -> subsection; paren balance
fpfz: section -> subsection
generator: examples moved to toplevel
geoip: invalid "string-append" tag -> div; section -> subsection

Note: author, examples too wide for pdf -- not fixed.

hashes: section -> subsection; create 'constant' signature tag

Excess whitespace not deleted; info file will be affected

honu: h3 -> subsection
html-plots: wrap license body in p (block tag)
html-stream: wrap license body in p (block tag)
imlib2: section -> subsection; subsection -> subsubsection [new in eggdoc 1.2]
javahack: paren fix
levenshtein: usage -> pre; fix examples nesting; convert References to section
mathh: section -> subsection
md5: section -> subsection
message-digest: section -> subsection
misc-extn: section -> subsection
mysql: (requires (p ...)) -> (requires (span ...))
openssl: move license to section level
r6rs-libraries: section->subsection; use eggdoc:make-defsig for library tag (for convenience)
rfc822: handle and use constant tag, multiline tt -> pre, (tt (pre ...)) -> (pre ...)

fix one (procedure) nesting

ripemd: section->subsection
rlimit: move section to toplevel; use eggdoc:make-defsig [new in eggdoc 1.2]
sha1, sha2: section->subsection
sql: (table ,transforms) -> (table ,@transforms) -- eggdoc-textinfo requires

(table (tr ...) (tr ...)) not (table ((tr ...) (tr ...)))

sqlite3: moved license section to toplevel
srfi-19, 27, 29: section->subsection
suspension: paren fix
sx: extraneous quasiquote
sxml-match: move license section tag to toplevel
synch: section->subsection
tiger-hash: section->subsection
z3: section->subsection

File size: 3.3 KB
Line 
1;;;; fpfz-eggdoc.scm
2
3(use eggdoc)
4
5(define license
6"Copyright (c) 2006, Kon Lovett.  All rights reserved.
7
8Permission is hereby granted, free of charge, to any person obtaining a
9copy of this software and associated documentation files (the Software),
10to deal in the Software without restriction, including without limitation
11the rights to use, copy, modify, merge, publish, distribute, sublicense,
12and/or sell copies of the Software, and to permit persons to whom the
13Software is furnished to do so, subject to the following conditions:
14
15The above copyright notice and this permission notice shall be included
16in all copies or substantial portions of the Software.
17
18THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24OTHER DEALINGS IN THE SOFTWARE.")
25
26(define doc `(
27        (eggdoc:begin
28                (name "fpfz")
29                (description (p "Floating-point Comparison With Epsilon"))
30                (author (url "mailto:klovett@pacbell.net" "Kon Lovett"))
31                (history
32                        (version "0.1" "Initial release"))
33
34                (usage)
35                (download "fpfz.egg")
36                (requires miscmacros)
37
38                (documentation
39
40                        (p "Routines to perform floating-point operations with an error
41                        bound. These routines are not some cure-all for floating-point
42                        anomalies, but useful anyway.")
43
44                        (subsection "Parameters"
45
46                                (parameter "(current-fpfz-epsilon [#])"
47                                        (p "Sets or returns the error bound."))
48                        )
49
50                        (subsection "Predicates"
51
52                                (p "The formula below are for exposition only; they are not the
53                                actual test.")
54
55                                (macro "(fpfz= A B [EPSILON (current-fpfz-epsilon)])"
56                                        (p "|a - b| <= E."))
57
58                                (macro "(fpfz<> A B [EPSILON (current-fpfz-epsilon)])"
59                                        (p "|a - b| > E."))
60
61                                (macro "(fpfz> A B [EPSILON (current-fpfz-epsilon)])"
62                                        (p "|a - b| > E."))
63
64                                (macro "(fpfz< A B [EPSILON (current-fpfz-epsilon)])"
65                                        (p "|a - b| < E."))
66
67                                (macro "(fpfz>= A B [EPSILON (current-fpfz-epsilon)])"
68                                        (p "|a - b| >= E."))
69
70                                (macro "(fpfz<= A B [EPSILON (current-fpfz-epsilon)])"
71                                        (p "|a - b| <= E."))
72                        )
73
74                        (subsection "Operations"
75
76                                (macro "(roundn N [ND])"
77                                        (p "Nearest number within a given precision, the number of
78                                        decimal digits in the fraction " (tt "ND") ". When precision
79                                        missing normal 'round' is performed."))
80
81                                (macro "(fpfzroundn N [ND])"
82                                        (p "Nearest number within a given precision, the number of
83                                        decimal digits in the fraction " (tt "ND") ", & epsilon. When
84                                        precision missing normal 'round' is performed."))
85
86                                (macro "(fpfzceil N)"
87                                        (p "Smallest integer number that is tolerably larger than
88                                        the given value."))
89
90                                (procedure "(fpfzfloor N)"
91                                        (p "Smallest integer number that is tolerably smaller than
92                                        the given value."))
93
94                                (macro "(fpmaxabs A B)"
95                                        (p "Mininum of the absolute value of the arguments."))
96
97                                (procedure "(calculate-fpfz-epsilon [FEPS 3.0])"
98                                        (p "Returns the system epsilon to within a factor of the real
99                                        epsilon."))
100
101                        )
102                )
103
104                (section "License" (pre ,license))
105        )
106))
107
108(eggdoc->html doc)
Note: See TracBrowser for help on using the repository browser.