[Firebird-net-provider] New documentation format for external files in 1.5 version

[Carlos G. A. <car...@te...>]

Hello:


I'm thinking in use a new format for external documentation files it 
would be similar to the described here:

http://www.go-mono.com/monodoc-xml.html

One thing that really i want to change are the documentation comments 
that at this moment are in general the same as in the MS help as i can 
think this is copyrighted y will try to express it with my own words, 
when i can :)


A little sample:

<?xml version="1.0" encoding="utf-8" ?>
<doc>
	<class name="FbConnection">
		<overview>
			<summary>Represents an open connection to a Firebird database. This 
class cannot be inherited.</summary>
			<remarks>
				<para>A <b>FbConnection</b> object represents a individual 
connection to Firebird server.</para>
				<para>If a <b>FbConnection</b> object goes out of scope, it is not 
closed,
				you must explicitly close the the connection by calling	<see 
cref="FbConnection.Close" /> or <see cref="FbConnection.Dispose" />.	
			</para>
			</remarks>
			<example>
				<code>			
public void InsertRow(string connectionString)
{
	//	If the connection string is null, use a default.
	if(connectionString == "")
	{
		connectionString = "Database=C:\\PROGRAM 
FILES\\FIREBIRD\\EXAMPLES\\EMPLOYEE.GDB;User=SYSDBA;Password=masterkey;Dialect=3;Server=localhost";
	}
	
	FbConnection connection = new FbConnection(connectionString);					
	connection.Open();					
	FbTransaction transaction	= connection.BeginTransaction();
	
	string insertQuery = "INSERT INTO PROJECT(proj_id, proj_name, product) 
Values('FBNP', '.NET Provider', 'N/A')";
	FbCommand command = new FbCommand(insertQuery, myConn, myTxn);	
	
	command.ExecuteNonQuery();
	
	transaction.Commit();
	
	connection.Close();
}
				</code>
			</example>
		</overview>
		
		<event name="StateChange">
			<summary>Occurs when the state of the connection changes.</summary>
			<remarks>
				<para>The <see cref="FbConnection.StateChange" /> event is raised 
when the connection state changes
				from Closed to Opened, or from Opened to Closed.
				</para>
			</remarks>
			<data>
				<list type="table">
					<listheader>
						<term>Property</term>
						<term>Description</term>
					</listheader>
					<item>
						<description>CurrentState</description>
						<description>The new state of the connection.</description>
					</item>
					<item>
						<description>OriginalState</description>
						<description>The original state of the connection.</description>
					</item>
				</list>
			</data>
		</event>
		
		<event name="InfoMessage">
			<summary>
			Occurs when the Firebird Server sends a warning message.
			</summary>
		</event>		
	</class>
</doc>






-- 
Best regards

Carlos Guzmán Álvarez
Vigo-Spain