source: project/match-action/match-action-eggdoc.scm @ 3394

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

Added support for matchable.

File size: 2.4 KB
Line 
1;;;; match-action-eggdoc.scm
2
3(use eggdoc)
4
5(define license #<<EOF
6Copyright (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.
25EOF
26)
27
28(define examples '((pre #<<EOF
29EOF
30)))
31
32(define doc `(
33(eggdoc:begin
34                (name "match-action")
35                (description (p "Match extension with explicit success & fail actions."))
36                (author (url "mailto:klovett@pacbell.net" "Kon Lovett"))
37                (history
38                        (version "0.2" "Added matchable egg support for hygienic macros")
39                        (version "0.1" "Initial release"))
40    (requires
41      match
42      matchable)
43                (usage)
44                (download "match-action.egg")
45
46                (documentation
47
48                        (p "A version of the 'match' macro with inline handlers for successful and unsuccessful "
49                        "matching.")
50
51                        (p "For a description of the acceptable patterns please see the \"Pattern Matching\" "
52                        "section of the Chicken manual.")
53
54                        (macro "(match/action ON-SUCCESS ON-FAIL MATCH-EXPRESSION [MATCH-CLAUSE ...])"
55                                (p "Pattern matching control form.")
56                                (symbol-table
57                                        (describe ON-SUCCESS
58                                                (p "An expression to be evaluated when a successful match occurs."))
59                                        (describe ON-FAIL
60                                                (p "An expression to be evaluated when a unsuccessful match occurs."))
61                                        (describe MATCH-EXPRESSION
62                                                (p "An expression whose value is matched against the supplied match pattern(s)."))
63                                        (describe MATCH-CLAUSE
64                                                (p "A pattern/action clause acceptable by the " (code "match") " macro."))) )
65                        )
66
67                #;(examples ,examples)
68
69                (section "License" (pre ,license))
70        )
71))
72
73(eggdoc->html doc)
Note: See TracBrowser for help on using the repository browser.