README
1ScanDoc - Version 0.14, A C/C++ Embedded Documentation Analyser
2----------------------------------------------------------------
3
4WHAT IS SCANDOC?
5
6 ScanDoc scans C and C++ program for embedded documentation, and
7 formats it into HTML or other formats. It also analyzes code
8 structure and uses this information to enhance the generated
9 documentation. It has been inspired by JavaDoc, as well as the
10 Amiga "autodoc" utility.
11
12LICENSING
13
14 ScanDoc is distributed under the "Artistic License" (see the file
15 "COPYING" for more information).
16
17DOCUMENTATION
18
19 ScanDoc's documentation can be found in the file "scandoc.html"
20 as well as on the web at http://scandoc.sourceforge.net/scandoc.html
21
22INSTALLATION
23
24 ScanDoc doesn't require system installation. You can simply include
25 ScanDoc with the source code you are documenting. Copy "scandoc",
26 your template file (try "templates/default.scandoc" if you haven't
27 built your own), and the images directory to your package's
28 documentation directory.
29
30 To see ScanDoc in action, go to the "test" dir and type "make".
31 ScanDoc will build documentation for the included test files.
32
33VERSION HISTORY
34
35 0.14 Mostly bug fixes.
36 0.13 Mostly bug fixes.
37 0.12 Mostly formatting and packaging changes.
38 0.11 Fixed parser bugs with global functions.
39 0.10 Fixed parser bugs reported by users.
40 0.9 First public release.
41
42 See "ChangeLog" for more details.
43
44CONTRIBUTORS:
45
46 Talin <talin@acm.org>
47 James Dean Palmer <james@tiger-marmalade.com>
48
49(c) 1997-2000 Talin and others
50