Click here to Skip to main content
15,892,005 members
Articles / Database Development / SQL Server

SQL XML Documentation

Rate me:
Please Sign up or sign in to vote.
4.59/5 (12 votes)
29 Feb 2008CPOL5 min read 113.1K   1.4K   75  
How to create and compile SQL XML Documentation comments
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>JocysCom.Sql.ScriptsGenerator</name>
    </assembly>
    <members>
        <member name="F:JocysCom.Sql.ScriptsGenerator.Controls.GenerateDataBaseScripts.components">
            <summary> 
            Required designer variable.
            </summary>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.GenerateDataBaseScripts.Dispose(System.Boolean)">
            <summary> 
            Clean up any resources being used.
            </summary>
            <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.GenerateDataBaseScripts.InitializeComponent">
            <summary> 
            Required method for Designer support - do not modify 
            the contents of this method with the code editor.
            </summary>
        </member>
        <!-- Badly formed XML comment ignored for member "P:JocysCom.Sql.ScriptsGenerator.Controls.GenerateDataBaseScripts.dbaConnectionString" -->
        <member name="F:JocysCom.Sql.ScriptsGenerator.MainForm.components">
            <summary>
            Required designer variable.
            </summary>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.MainForm.Dispose(System.Boolean)">
            <summary>
            Clean up any resources being used.
            </summary>
            <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.MainForm.InitializeComponent">
            <summary>
            Required method for Designer support - do not modify
            the contents of this method with the code editor.
            </summary>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.GenerateActionScripts.GetDeleteProcedure">
            <summary>
            Generate delete script.
            </summary>
            <returns>SQL script.</returns>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.GenerateActionScripts.GetPrimaryKey(Microsoft.SqlServer.Management.Smo.Table)">
            <summary>
            Get primary key column from table.
            </summary>
            <param name="table">Table to search for primary key.</param>
            <returns>Primary key column.</returns>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.GenerateActionScripts.GetIdentity(Microsoft.SqlServer.Management.Smo.Table)">
            <summary>
            Get identity column from table.
            </summary>
            <param name="table">Table to search for identity column.</param>
            <returns>Identity column.</returns>
        </member>
        <member name="F:JocysCom.Sql.ScriptsGenerator.Controls.GenerateActionScripts.components">
            <summary> 
            Required designer variable.
            </summary>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.GenerateActionScripts.Dispose(System.Boolean)">
            <summary> 
            Clean up any resources being used.
            </summary>
            <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.GenerateActionScripts.InitializeComponent">
            <summary> 
            Required method for Designer support - do not modify 
            the contents of this method with the code editor.
            </summary>
        </member>
        <!-- Badly formed XML comment ignored for member "P:JocysCom.Sql.ScriptsGenerator.Controls.GenerateActionScripts.dbaConnectionString" -->
        <member name="T:JocysCom.Sql.ScriptsGenerator.Controls.ProcedureHeaders">
            <summary>
            ProcedureHeaders user control.
            </summary>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.ProcedureHeaders.#ctor">
            <summary>
            ProcedureHeaders.
            </summary>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.ProcedureHeaders.filterConnectionString(System.String)">
            <summary>
            Hide connection string password.
            </summary>
            <param name="text"></param>
            <returns></returns>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.ProcedureHeaders.LoadCurrentProcedure">
            <summary>
            Load selected procedure.
            </summary>
        </member>
        <member name="F:JocysCom.Sql.ScriptsGenerator.Controls.ProcedureHeaders.components">
            <summary> 
            Required designer variable.
            </summary>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.ProcedureHeaders.Dispose(System.Boolean)">
            <summary> 
            Clean up any resources being used.
            </summary>
            <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.ProcedureHeaders.InitializeComponent">
            <summary> 
            Required method for Designer support - do not modify 
            the contents of this method with the code editor.
            </summary>
        </member>
        <member name="P:JocysCom.Sql.ScriptsGenerator.Controls.ProcedureHeaders.dbaConnectionString">
            <summary>
            Database Administrative Connection String.
            </summary>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Program.Main">
            <summary>
            The main entry point for the application.
            </summary>
        </member>
        <member name="T:JocysCom.Sql.ScriptsGenerator.Properties.Resources">
            <summary>
              A strongly-typed resource class, for looking up localized strings, etc.
            </summary>
        </member>
        <member name="P:JocysCom.Sql.ScriptsGenerator.Properties.Resources.ResourceManager">
            <summary>
              Returns the cached ResourceManager instance used by this class.
            </summary>
        </member>
        <member name="P:JocysCom.Sql.ScriptsGenerator.Properties.Resources.Culture">
            <summary>
              Overrides the current thread's CurrentUICulture property for all
              resource lookups using this strongly typed resource class.
            </summary>
        </member>
        <member name="F:JocysCom.Sql.ScriptsGenerator.Controls.XmlCommentsExtractTest.components">
            <summary> 
            Required designer variable.
            </summary>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.XmlCommentsExtractTest.Dispose(System.Boolean)">
            <summary> 
            Clean up any resources being used.
            </summary>
            <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
        </member>
        <member name="M:JocysCom.Sql.ScriptsGenerator.Controls.XmlCommentsExtractTest.InitializeComponent">
            <summary> 
            Required method for Designer support - do not modify 
            the contents of this method with the code editor.
            </summary>
        </member>
        <member name="T:JocysCom.Sql.ScriptsGenerator.LogEventArgs">
            <summary>
            Used by GenerateDataBaseScript class.
            </summary>
        </member>
    </members>
</doc>

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer (Senior)
United Kingdom United Kingdom
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions