コード例 #1
0
        public override void WritePage(UdnManifest Manifest, string OutputPath)
        {
            using (UdnWriter Writer = new UdnWriter(OutputPath))
            {
                Writer.WritePageHeader("Unreal Engine API Reference", PageCrumbs, "Unreal Engine API Reference");

                Writer.WriteHeading(2, "Disclaimer");

                Writer.WriteLine("The API reference is an early work in progress, and some information may be missing or out of date. It serves mainly as a low level index of Engine classes and functions.");
                Writer.WriteLine("For tutorials, walkthroughs and detailed guides to programming with Unreal, please see the [Unreal Engine Programming](http://docs.unrealengine.com/latest/INT/Programming/index.html) home on the web.");
                Writer.WriteLine();
                Writer.WriteLine("To explore the API from some of the most frequently encountered Unreal concepts and types, see the API __[getting started](" + GettingStarted.LinkPath + ")__ page.");

                Writer.WriteHeading(2, "Contents");

                Writer.EnterRegion("memberindexlinks");
                Writer.WriteLine("[Getting started]({0}) · [All constants]({1}) · [All functions]({2}) · [All enums]({3}) · [All classes]({4}) · [Class hierarchy]({5})", GettingStarted.LinkPath, ConstantIndex.LinkPath, FunctionIndex.LinkPath, EnumIndex.LinkPath, RecordIndex.LinkPath, RecordHierarchy.LinkPath);
                Writer.LeaveRegion();

                foreach (APIModuleIndex ChildModuleIndex in ChildModuleIndexes)
                {
                    Writer.WriteHeading(2, ChildModuleIndex.Name);
                    Writer.EnterRegion("modules-list");
                    ChildModuleIndex.WriteModuleList(Writer, 3);
                    Writer.LeaveRegion();
                }

                Writer.WriteLine("<br>");
            }
        }
コード例 #2
0
        public void WriteSitemapContents(string OutputPath)
        {
            List <SitemapNode> RootNodes = new List <SitemapNode>();

            RootNodes.Add(new SitemapNode("Contents", SitemapLinkPath));
            RootNodes.Add(new SitemapNode("Getting started", GettingStarted.SitemapLinkPath));
            foreach (APIModuleIndex ChildModuleIndex in ChildModuleIndexes)
            {
                RootNodes.Add(ChildModuleIndex.CreateSitemapNode());
            }
            RootNodes.Add(new SitemapNode("All constants", ConstantIndex.SitemapLinkPath));
            RootNodes.Add(new SitemapNode("All functions", FunctionIndex.SitemapLinkPath));
            RootNodes.Add(new SitemapNode("All enums", EnumIndex.SitemapLinkPath));
            RootNodes.Add(new SitemapNode("All classes", RecordIndex.SitemapLinkPath));
            RootNodes.Add(new SitemapNode("Class hierarchy", RecordHierarchy.SitemapLinkPath));
            Sitemap.WriteContentsFile(OutputPath, RootNodes);
        }