source: project/uuid-lib/uuid-lib-eggdoc.scm @ 3521

Last change on this file since 3521 was 3521, checked in by Kon Lovett, 13 years ago

Bug fix for import failure. Rqrd copying the .scm & spliting the C api out to own extn.

File size: 3.7 KB
Line 
1;;;; uuid-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 "uuid-lib")
29    (description (p "OSF DCE 1.1 UUID"))
30    (author (url "mailto:klovett@pacbell.net" "Kon Lovett"))
31    (history
32      (version "1.1" "Bug fix for import [Reported by arto]")
33      (version "1.0" "Initial release"))
34    (requires
35      (url "syntax-case.html" "syntax-case"))
36    (usage)
37    (download "uuid-lib.egg")
38
39    (documentation
40
41      (p "Wrapper for " (code "uuid/uuid.h") " procedures on MacOS X, "
42      "and Linux.")
43
44      (p "This is a module. You must " (code "(import uuid-lib)") " to "
45      "access these procedures.")
46
47      (subsection "Predicates"
48
49        (procedure "(uuid? UUID)"
50          (p "Is " (tt "UUID") " a uuid?"))
51
52        (procedure "(uuid-null? UUID)"
53          (p "Is " (tt "UUID") " the \"null\" uuid?"))
54
55        (procedure "(uuid=? UUID1 UUID2)"
56          (p "Are " (tt "UUID1") " and " (tt "UUID2") " equal?"))
57
58        (procedure "(uuid<>? UUID1 UUID2)"
59          (p "Are " (tt "UUID1") " and " (tt "UUID2") " not equal?"))
60
61        (procedure "(uuid<? UUID1 UUID2)"
62          (p "Does " (tt "UUID1") " order below " (tt "UUID2") "?"))
63
64        (procedure "(uuid>? UUID1 UUID2)"
65          (p "Does " (tt "UUID1") " order above " (tt "UUID2") "?"))
66
67        (procedure "(uuid<=? UUID1 UUID2)"
68          (p "Does " (tt "UUID1") " order below or the same as " (tt
69          "UUID2") "?"))
70
71        (procedure "(uuid>=? UUID1 UUID2)"
72          (p "Does " (tt "UUID1") " order above or the same as " (tt
73          "UUID2") "?"))
74      )
75
76      (subsection "Operations"
77
78        (procedure "(uuid-clear! UUID)"
79          (p "Returns the " (tt "UUID") " set to the null uuid."))
80
81        (procedure "(uuid-copy UUID)"
82          (p "Returns a copy of the " (tt "UUID") "."))
83
84        (procedure "(uuid-generate [#:method #f])"
85          (p "Returns a new uuid.")
86
87          (p "Method is " (code "#f") ", " (code "'random") ", or "
88          (code "'time") "."))
89
90        (procedure "(uuid-parse UUID-TEXT)"
91          (p "Returns a new uuid from the UUID external string representation "
92          (tt "UUID-TEXT") "."))
93
94        (procedure "(uuid-unparse UUID [#:case #f])"
95          (p "Returns the external string representation of " (tt "UUID") ".")
96
97          (p "Case is " (code "#f") ", " (code "'upper") ", or " (code "'lower") "."))
98      )
99
100      (subsection "Errors"
101
102        (p "Argument errors are signalled using " (code "error") ".")
103
104        (p "When a non-uuid is given as an argument the result is "
105        (code "#f") ".")
106      )
107    )
108
109    (section "License" (pre ,license))
110  )
111))
112
113(eggdoc->html doc)
Note: See TracBrowser for help on using the repository browser.