Example.sql File Reference

The examples of what sql2doxygen can cope with. More...

Data Structures
struct	MyTable
	This table definition uses the C-style comment. More...
struct	MyOtherTable
	This table definition uses the SQL-equivalent block comment style. More...
struct	MyFinalTable
	The final table definition uses the other SQL-equivalent block comment style. More...
struct	dbo::BracketsTable
	A table definition that has a schema and []'s in the names. More...
Functions
varchar[10]	MyNoArgsFunction ()
BracketType	dbo::BracketsFunction ()
varchar[20]	MyOtherNoArgsFunction ()
varchar[20]	OneMoreNoArgsFunction ()
varchar[10]	MyFunction (tinyint @value1, smalldatetime @value2)
void	MyNoArgProcedure ()
void	dbo::BracketsProcedure (BracketType @aParam)
void	MyMultiArgProcedure (tinyint @value1, varchar[10]@value2)

---

Detailed Description

The examples of what sql2doxygen can cope with.

Author:

Chris Oldwood

This file contains various SQL object definitions and comment styles to show what sql2doxygen can transform.

---

Function Documentation

varchar [10] MyNoArgsFunction

(

)

A function that takes no arguments. NB: The signature is written on a single line.

varchar [20] MyOtherNoArgsFunction

(

)

A function that takes no arguments and spans multiple lines.

varchar [20] OneMoreNoArgsFunction

(

)

A function that takes no arguments where the return is specified on a separate line.

varchar [10] MyFunction	(	tinyint @	value1,
		smalldatetime @	value2
	)

A function that takes one or more arguments.

Parameters:

value1	The 1st argument.
value2	The 2nd argument.

void MyNoArgProcedure

(

)

A procedure that takes no arguments.

void MyMultiArgProcedure	(	tinyint @	value1,
		varchar @	value2[10]
	)

A procedure that takes arguments.

Parameters:

value1	The 1st argument.
value2	The 2nd argument.

---