Skip to content

Commit ba9311a

Browse files
committed
Added Introduction section as this file is also now the entry point on GitHub.
1 parent bb2ba70 commit ba9311a

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

ReadMe.txt

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
11
sql2doxygen v0.2 [Alpha]
22
========================
33

4+
Introduction
5+
------------
46

5-
1: Installation
6-
---------------
7+
Doxygen is a tool for generating documentation from source code and it
8+
currently handles many languages either natively or through add-on filters.
9+
This script is one such filter that transforms T-SQL into C-like code so that
10+
Doxygen can then parse it natively.
711

8-
Copy the files sql2doxygen.* to a suitable location.
12+
While this means that you can benefit from the automated generation of
13+
documentation it does mean that you have to mentally translate a 'struct' back
14+
into a 'table' and reverse the type and member/variable names in declarations.
915

16+
Documentation
17+
-------------
1018

11-
2: Help/Manual
12-
--------------
19+
There is a manual: sql2doxygen.html.
1320

14-
There is a HelpFile - sql2doxygen.html.
15-
16-
17-
3: Contact Details
21+
Contact Details
1822
------------------
1923

2024
Email: gort@cix.co.uk
21-
Web: http://www.cix.co.uk/~gort
22-
25+
Web: http://www.chrisoldwood.com
2326

2427
Chris Oldwood
25-
2628
31st January 2012

0 commit comments

Comments
 (0)