private void WriteStoredProcedureDocument(StoredProcedure sp, HtmlBuilder html, DatabaseContext context)
        {
            html.h1(String.Format("Stored Procedure: {0}", sp.Name));

            html.e("table");
            html.tr().td().attCls("label").text("Database:").c().td();
            String relDoc = String.Format("{0}.{1}.{1}", context.BookName, context.DbName);
            html.internalLink(context.DbName, "db-entity-name", relDoc, sp.Name);
            html.c().c();
            html.c(); //table

            html.h2("Parameters");
            if (sp.Parameters != null && sp.Parameters.Count > 0)
            {
                html.table(0, 0).att("width", "100%").attCls("members");
                html.dbSpParamHeader();

                foreach (var p in sp.Parameters)
                {
                    html.tr()
                        .rowHeader(false)
                        .td()
                            .attCls(p.IsOutputParameter ? "sp-parameter output" : "sp-parameter input")
                            .att("title", p.IsOutputParameter ? "output" : "input")
                            .text(p.Name.TrimStart('@'))
                        .c()
                        .td()
                            .dataType(p.DataType)
                        .c()
                    .c();
                }

                html.c(); // table
            }
            else
                html.text("This stored procedure does not receive parameters.");
        }
Пример #2
0
        private void WriteDatabaseDocument(Database db, HtmlBuilder html, DatabaseContext context)
        {
            html.h1(String.Format("Database: {0}", db.Name));

            #region Tables

            html.e("a").attCls("tables").c();
            html.h2("Tables");
            if (db.Tables == null || db.Tables.Count == 0)
                html.text("This database has no tables.");
            else
            {
                html.table(0, 0).att("width", "100%").attCls("members");
                html.dbTableHeader();

                foreach (var t in db.Tables)
                {
                    html.tr().attCls("expandable");
                    html.td().attCls("micon").e("a").attCls("exi").att("href", "#expand").nbsp().c().c();
                    String relDoc = String.Format("{0}.{1}.Tables.{2}.{3}", context.BookName, context.DbName, t.SchemaName, t.Name);
                    html.td().internalLink(t.Name, "db-entity-name " + t.Name, relDoc); // Anchor and link in one element (e.g. <a class="db-entity-name Parties" ...>)
                    html.div().attCls("details");
                    RenderColumnsSection(t.Columns, html);
                    html.c(); // details
                    html.c(); // td
                    html.td().text(t.SchemaName).c();
                    html.c(); // tr
                }

                html.c(); // table
            }

            #endregion

            #region Views

            html.e("a").attCls("views").c();
            html.h2("Views");
            if (db.Views == null || db.Views.Count == 0)
                html.text("This database has no views.");
            else
            {
                html.table(0, 0).att("width", "100%").attCls("members");
                html.dbTableHeader();

                foreach (var v in db.Views)
                {
                    html.tr().attCls("expandable");
                    html.td().attCls("micon").e("a").attCls("exi").att("href", "#expand").nbsp().c().c();
                    String relDoc = String.Format("{0}.{1}.Views.{2}.{3}", context.BookName, context.DbName, v.SchemaName, v.Name);
                    html.td().internalLink(v.Name, "db-entity-name " + v.Name, relDoc);
                    html.div().attCls("details");
                    RenderColumnsSection(v.Columns, html);
                    html.c(); // details
                    html.c(); // td

                    html.td().text(v.SchemaName).c();

                    html.c(); // tr
                }

                html.c(); // table
            }

            #endregion

            #region Stored procedures

            html.e("a").attCls("stored-procedures").c();
            html.h2("Stored procedures");
            if (db.StoredProcedures == null || db.StoredProcedures.Count == 0)
                html.text("This database has no stored procedures.");
            else
            {
                html.table(0, 0).att("width", "100%").attCls("members");
                html.dbSpHeader();

                foreach (var sp in db.StoredProcedures)
                {
                    html.tr().attCls("expandable");
                    html.td().attCls("micon").e("a").attCls("exi").att("href", "#expand").nbsp().c().c();

                    String relDoc = String.Format("{0}.{1}.Procedures.{2}", context.BookName, context.DbName, sp.Name);
                    html.td().internalLink(sp.Name, "db-entity-name " + sp.Name, relDoc);

                    html.div().attCls("details");
                    RenderParametersSection(sp.Parameters, html);
                    html.c(); // details

                    html.c(); // td
                    html.c(); // tr
                }

                html.c(); // table
            }

            #endregion
        }
Пример #3
0
        public void Write(DoxDocument dox, DoxFormattingContext outputContext)
        {
            var output = outputContext.Output;
            using (var hw = new HtmlTextWriter(output))
            {
                var html = new HtmlBuilder(hw);
                html.div().attCls("dox").att("dox:format", "class");

                if (dox.Type != null)
                {
                    html.e("h1");
                    switch (dox.Type.TypeKind)
                    {
                        case TypeKind.CLASS:
                            html.text("class ");
                            break;
                        case TypeKind.ENUM:
                            html.text("enum ");
                            break;
                        case TypeKind.INTERFACE:
                            html.text("interface ");
                            break;
                        case TypeKind.STRUCT:
                            html.text("struct ");
                            break;
                        case TypeKind.DELEGATE:
                            html.text("delegate ");
                            break;
                    }

                    html.text(dox.Type.Name);
                    html.c();//h1;
                    var referenceContext = new ReferenceContext
                    {
                        BookName = outputContext.BookName,
                        Namespace = dox.Type.Namespace
                    };

                    html.e("table");
                    html.tr().td().attCls("label").text("Namespace:").c().td().text(dox.Type.Namespace).c().c();
                    html.tr().td().attCls("label").text("Base:").c().td();
                    if (dox.Type.BaseTypes != null)
                    {
                        bool first = true;
                        foreach (var bt in dox.Type.BaseTypes)
                        {
                            if (first)
                                first = false;
                            else html.text(", ");
                            html.typeName(bt, referenceContext);
                        }
                    }
                    html.c().c();
                    html.c(); //table

                    RenderExtendedSummary(dox.Type, html, referenceContext);

                    #region Fields

                    html.anchor("fields");
                    html.h2("Fields");
                    if (dox.Type.Fields == null || dox.Type.Fields.Count == 0)
                        html.text("This class has no fields.");
                    else
                    {
                        html.table(0, 0).att("width", "100%").attCls("members");
                        html.tableHeader();
                        foreach (var m in dox.Type.Fields.OrderBy(a => a.Name))
                        {
                            html.tr();//.attCls("expandable");
                            //html.td().attCls("micon").e("a").attCls("exi").att("href", "#expand").nbsp().c().c();
                            html.td().attCls("micon").nbsp().c();

                            html.td().member(m, referenceContext);
                            if (m.InitLiteral != null)
                                html.text(" = ").text(m.InitLiteral);
                            //html.div().attCls("details");
                            RenderExtendedSummary(m, html, referenceContext);
                            //html.c(); // details;
                            html.c(); //td
                            html.td().att("width", "10%").typeName(m.DeclaringType, m.DeclaringType + "-" + m.Name, referenceContext).c();
                            html.c(); //tr
                        }
                        html.c(); //table
                    }

                    #endregion Fields

                    #region Properties

                    html.e("a").attCls("properties").c();
                    html.h2("Properties");
                    if (dox.Type.Properties == null || dox.Type.Properties.Count == 0)
                        html.text("This class has no properties.");
                    else
                    {
                        html.table(0, 0).att("width", "100%").attCls("members");
                        html.tableHeader();
                        foreach (var m in dox.Type.Properties.OrderBy(a => a.Name))
                        {
                            html.tr();

                            if (m.Parameters != null) //indexers
                            {
                                html.attCls("expandable");
                                html.td().attCls("micon").e("a").attCls("exi").att("href", "#expand").nbsp().c().c();
                            }
                            else
                                html.td().attCls("micon").nbsp().c();

                            html.td().member(m, referenceContext);
                            if (m.Parameters != null)
                            {
                                html.text("[");
                                RenderParameters(html, m.Parameters, referenceContext);
                                html.text("]");
                            }
                            html.text(" { ");
                            if (m.CanRead) html.text("get; ");
                            if (m.CanWrite) html.text("set; ");
                            html.text("}");
                            RenderExtendedSummary(m, html, referenceContext);

                            if (m.Parameters != null)
                            {
                                html.div().attCls("details");
                                RenderMethodParametersAndReturnsSummary(html, m, referenceContext);
                                html.c(); // details
                            }

                            html.c(); //td
                            html.td().att("width", "10%").typeName(m.DeclaringType, m.DeclaringType + "-" + m.Name, referenceContext).c();
                            html.c(); //tr
                        }
                        html.c();
                    }

                    #endregion Properties

                    #region Methods

                    html.anchor("methods");
                    html.h2("Methods");
                    if (dox.Type.Methods == null || dox.Type.Methods.Count == 0)
                        html.text("This class has no methods.");
                    else
                    {
                        html.table(0, 0).att("width", "100%").attCls("members");
                        html.tableHeader();
                        foreach (var m in dox.Type.Methods.OrderByDescending(a => a.MemberFlag & MemberFlag.CONSTRUCTOR).ThenBy(a => a.Name))
                        {
                            html.tr();
                            if (m.Parameters != null || (m.TypeName != null && m.TypeName != "System.Void" && m.TypeName != "void"))
                            {
                                html.attCls("expandable");
                                html.td().attCls("micon").e("a").attCls("exi").att("href", "#expand").nbsp().c().c();
                            }
                            else
                                html.td().attCls("micon").nbsp().c();

                            html.td().member(m, referenceContext);
                            html.text("(");
                            RenderParameters(html, m.Parameters, referenceContext);
                            html.text(")");
                            RenderExtendedSummary(m, html, referenceContext);
                            html.div().attCls("details");
                            RenderMethodParametersAndReturnsSummary(html, m, referenceContext);
                            html.c(); // details
                            html.c(); //td
                            html.td().att("width", "10%").typeName(m.DeclaringType, m.DeclaringType + "-" + m.Name, referenceContext).c();
                            html.c(); //tr
                        }
                        html.c();
                    }

                    #endregion Methods

                    #region Events

                    html.anchor("events");
                    html.h2("Events");
                    if (dox.Type.Events == null || dox.Type.Events.Count == 0)
                        html.text("This class has no events.");
                    else
                    {
                        html.table(0, 0).att("width", "100%").attCls("members");
                        html.tableHeader();
                        foreach (var m in dox.Type.Events.OrderBy(a => a.Name))
                        {
                            html.tr();//.attCls("expandable");
                            //html.td().attCls("micon").e("a").attCls("exi").att("href", "#expand").nbsp().c().c();
                            html.td().attCls("micon").nbsp().c();

                            html.td().member(m, "event ", referenceContext);

                            //html.div().attCls("details");
                            RenderExtendedSummary(m, html, referenceContext);
                            //html.c(); // details;
                            html.c(); //td
                            html.td().att("width", "10%").typeName(m.DeclaringType, m.DeclaringType + "-" + m.Name, referenceContext).c();
                            html.c(); //tr
                        }
                        html.c(); //table
                    }

                    #endregion Events
                }
                else
                    html.h1(dox.Title);

                //html.div().attCls("footer").text(dox.Title).c();
                html.c(); // dox div
            }
        }