source: project/wiki/eggref/4/introspect @ 32906

Last change on this file since 32906 was 32906, checked in by Mario Domenech Goulart, 5 years ago

introspect (wiki): initial documentation

File size: 2.1 KB
Line 
1[[tags: egg introspect]]
2
3== introspect
4
5[[toc:]]
6
7=== Introduction
8
9An introspection procedure that returns the symbols exported by a
10module.
11
12=== Author
13
14[[/users/mario-domenech-goulart|Mario Domenech Goulart]]
15
16=== Repository
17
18[[https://github.com/mario-goulart/introspect|https://github.com/mario-goulart/introspect]]
19
20=== API
21
22<procedure>(introspect #!optional mod) => list of symbols</procedure>
23
24When called without arguments, return a list with all symbols in the
25environment.  If given a module name (a symbol), return a list of
26symbols exported by the given module.
27
28
29=== License
30
31  Copyright (c) 2015, Mario Domenech Goulart
32  All rights reserved.
33 
34  Redistribution and use in source and binary forms, with or without
35  modification, are permitted provided that the following conditions
36  are met:
37  1. Redistributions of source code must retain the above copyright
38     notice, this list of conditions and the following disclaimer.
39  2. Redistributions in binary form must reproduce the above copyright
40     notice, this list of conditions and the following disclaimer in the
41     documentation and/or other materials provided with the distribution.
42  3. The name of the authors may not be used to endorse or promote products
43     derived from this software without specific prior written permission.
44 
45  THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
46  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
47  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
49  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
51  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
52  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
53  IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
54  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
55  IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
56
57
58=== Version history
59
60==== Version 0.1
61
62* Initial release
63
Note: See TracBrowser for help on using the repository browser.