private static void TestHierarchicalToc(BuildDocumenter documenter,
TestOptions options, ReferenceEngineSettings engineSettings)
{
if (tocType == CustomTocType.ReferenceRoot)
{
return;
}
string libraryDir = Path.Combine(sampleDir, @"SampleHierarchicalToc\");
string outputDir = Path.Combine(libraryDir, @"Output\");
//string projectDoc = Path.Combine(outputDir, "Project.xml");
ReferenceGroup apiGroup = new ReferenceGroup(
"Test Hierarchical Toc References", TestGroupIds.TestTocLibGroupId);
apiGroup.RunningHeaderText = "Sandcastle Helpers: Test Hierarchical Toc";
apiGroup.RootTopicId = "d36e744f-c053-4e94-9ac9-b1ee054d8de1";
apiGroup.VersionType = ReferenceVersionType.AssemblyAndFile;
if (engineSettings.RootNamespaceContainer)
{
apiGroup.RootNamespaceTitle = "HierarchicalToc Test References";
}
ReferenceContent apiContent = apiGroup.Content;
apiGroup.ContentFile = new BuildFilePath(Path.Combine(workingDir,
"HierarchicalToc" + BuildFileExts.ReferenceGroupExt));
apiContent.ContentFile = new BuildFilePath(Path.Combine(workingDir,
"HierarchicalToc" + BuildFileExts.ReferenceContentExt));
apiContent.FrameworkType = BuildFrameworkType.Framework35;
//apiGroup.AddItem(projectDoc, null);
apiContent.AddItem(Path.Combine(outputDir, "SampleHierarchicalToc.xml"),
Path.Combine(outputDir, "SampleHierarchicalToc.dll"));
//apiContent.AddDependency(Path.Combine(outputDir, "TestLibrary.dll"));
documenter.AddGroup(apiGroup);
}
private static void TestOthers0(BuildDocumenter documenter,
TestOptions options, ReferenceEngineSettings engineSettings)
{
if (tocType == CustomTocType.ReferenceRoot)
{
return;
}
string libraryDir = Path.Combine(sampleDir, @"SampleTestLibraryCLR\");
string outputDir = Path.Combine(libraryDir, @"Output\");
//string projectDoc = Path.Combine(outputDir, "Project.xml");
ReferenceGroup apiGroup = new ReferenceGroup(
"Test CPP-CLR Library", Guid.NewGuid().ToString());
apiGroup.RunningHeaderText = "Sandcastle Helpers: C++/CLR Library";
apiGroup.VersionType = ReferenceVersionType.AssemblyAndFile;
if (engineSettings.RootNamespaceContainer)
{
apiGroup.RootNamespaceTitle = "Testing C++/CLR Library";
}
ReferenceContent apiContent = apiGroup.Content;
apiGroup.ContentFile = new BuildFilePath(Path.Combine(workingDir,
"OtherReference" + BuildFileExts.ReferenceGroupExt));
apiContent.ContentFile = new BuildFilePath(Path.Combine(workingDir,
"OtherReference" + BuildFileExts.ReferenceContentExt));
apiContent.FrameworkType = BuildFrameworkType.Framework20;
//apiGroup.AddItem(projectDoc, null);
apiContent.AddItem(Path.Combine(outputDir, "SampleLibraryCLR.xml"),
Path.Combine(outputDir, "SampleLibraryCLR.dll"));
//apiContent.AddDependency(Path.Combine(outputDir, ""));
documenter.AddGroup(apiGroup);
}
private static void TestMain(BuildDocumenter documenter,
TestOptions options, ReferenceEngineSettings engineSettings)
{
// Decide which version information to use...
ReferenceVersionType versionType = ReferenceVersionType.Advanced;
string libraryDir = Path.Combine(sampleDir, @"SampleLibrary\");
string outputDir = Path.Combine(libraryDir, @"Output\");
string projectDoc = Path.Combine(outputDir, "Project.xml");
ReferenceGroup apiGroup = new ReferenceGroup(
"Test API References", TestGroupIds.TestLibGroupId);
apiGroup.RunningHeaderText = "Sandcastle Helpers: Test API Reference";
if (engineSettings != null && engineSettings.RootNamespaceContainer)
{
apiGroup.RootNamespaceTitle = "SampleLibrary Test References";
}
ReferenceContent apiContent = apiGroup.Content;
apiContent.FrameworkType = BuildFrameworkType.Framework35;
apiContent.AddItem(projectDoc, null);
apiContent.AddItem(Path.Combine(outputDir, "TestLibrary.xml"),
Path.Combine(outputDir, "TestLibrary.dll"));
apiGroup.AddSnippet(new CodeSnippetContent(Path.Combine(
libraryDir, "CodeSnippetSample.snippets")));
string helpTestDir = Path.Combine(sampleDir, @"SampleTopics\");
string mediaLinks = Path.Combine(helpTestDir, "MediaContent.media");
apiGroup.AddMedia(new MediaContent(mediaLinks,
Path.Combine(helpTestDir, "Media")));
// Create and add an API filter...
ReferenceNamespaceFilter namespaceFilter =
new ReferenceNamespaceFilter("TestLibrary", true);
namespaceFilter.Add(new ReferenceTypeFilter("Point3D", false, false));
apiContent.TypeFilters.Add(namespaceFilter);
documenter.AddGroup(apiGroup);
ReferenceVersionInfo versionInfo = null;
if (versionType == ReferenceVersionType.Advanced)
{
libraryDir = Path.Combine(sampleDir, @"SampleLibraryVersion\");
outputDir = Path.Combine(libraryDir, @"Output\");
apiContent = new ReferenceContent();
apiContent.FrameworkType = BuildFrameworkType.Framework20;
apiContent.AddItem(Path.Combine(outputDir, "TestLibrary.xml"),
Path.Combine(outputDir, "TestLibrary.dll"));
versionInfo = new ReferenceVersionInfo();
versionInfo.PlatformFilters = true;
//versionInfo.PlatformId = "netfw";
versionInfo.PlatformTitle = ".NET Framework";
//versionInfo.VersionId = "netfw20";
versionInfo.VersionLabel = "2.0";
ReferenceVersionSource source = new ReferenceVersionSource();
//source.VersionId = "netfw10";
source.VersionLabel = "1.0";
source.Content = apiContent;
versionInfo.AddSource(source);
apiGroup.VersionType = versionType;
apiGroup.VersionInfo = versionInfo;
}
if (versionType == ReferenceVersionType.Advanced &&
versionInfo != null)
{
libraryDir = Path.Combine(sampleDir, @"SampleLibrarySilverlight\");
outputDir = Path.Combine(libraryDir, @"Output\");
apiContent = new ReferenceContent();
apiContent.FrameworkType = BuildFrameworkType.Silverlight40;
apiContent.AddItem(Path.Combine(outputDir, "TestLibrary.xml"),
Path.Combine(outputDir, "TestLibrary.dll"));
ReferenceVersionRelated relatedVersion = new ReferenceVersionRelated();
relatedVersion.PlatformId = "silverlight_mobile";
//relatedVersion.PlatformTitle = "Silverlight for Windows Phone";
ReferenceVersionSource source = new ReferenceVersionSource();
source.VersionId = "silverlight_mobile_v1";
//source.VersionLabel = "Windows Phone OS 7.0";
source.Content = apiContent;
relatedVersion.Add(source);
versionInfo.AddRelated(relatedVersion);
}
}
private static void TestRedirection(BuildDocumenter documenter,
TestOptions options, ReferenceEngineSettings engineSettings)
{
if (tocType == CustomTocType.ReferenceRoot)
{
return;
}
string libraryDir = Path.Combine(sampleDir, @"SampleLibrary\Libraries\");
string outputDir = Path.Combine(libraryDir, @"Redirects\");
string projectDoc = Path.Combine(outputDir, "Project.xml");
ReferenceGroup apiGroup = new ReferenceGroup(
"Testing Redirection", Guid.NewGuid().ToString());
apiGroup.RunningHeaderText = "Sandcastle Helpers: Testing Assembly Redirection";
apiGroup.SyntaxType |= BuildSyntaxType.Xaml;
apiGroup.EnableXmlnsForXaml = true;
apiGroup.VersionType = ReferenceVersionType.Assembly;
if (engineSettings.RootNamespaceContainer)
{
apiGroup.RootNamespaceTitle = "Testing Assembly Redirection";
}
ReferenceContent apiContent = apiGroup.Content;
apiContent.FrameworkType = BuildFrameworkType.Framework40;
apiContent.AddItem(projectDoc, null);
ReferenceItem refItem = new ReferenceItem(
Path.Combine(outputDir, "Tests.Drawings.xml"),
Path.Combine(outputDir, "Tests.Drawings.dll"));
//refItem.XamlSyntax = true;
apiContent.Add(refItem);
//apiContent.AddDependency(Path.Combine(outputDir, "Tests.Shapes.dll"));
//apiContent.AddDependency(Path.Combine(outputDir, "Tests.Geometries.dll"));
documenter.AddGroup(apiGroup);
// Testing embedded documents...
//apiGroup = new ReferenceGroup(
// "Testing Embeddeding", Guid.NewGuid().ToString());
//apiGroup.ExcludeToc = true; //NOTE!!!
//apiGroup.RunningHeaderText = "Sandcastle Helpers: Testing Assembly Redirection";
//apiGroup.SyntaxType |= BuildSyntaxType.Xaml;
//apiGroup.EnableXmlnsForXaml = true;
//apiGroup.VersionType = ReferenceVersionType.Assembly;
//if (engineSettings.RootNamespaceContainer)
//{
// apiGroup.RootNamespaceTitle = "Testing Assembly Redirection";
//}
//apiContent = apiGroup.Content;
//apiContent.FrameworkType = BuildFrameworkType.Framework40;
//apiContent.AddItem(projectDoc, null);
//apiContent.AddItem(projectDoc, null);
//refItem = new ReferenceItem(
// Path.Combine(outputDir, "Tests.Shapes.xml"),
// Path.Combine(outputDir, "Tests.Shapes.dll"));
//refItem.XamlSyntax = true;
//apiContent.Add(refItem);
//refItem = new ReferenceItem(
// Path.Combine(outputDir, "Tests.Geometries.xml"),
// Path.Combine(outputDir, "Tests.Geometries.dll"));
//refItem.XamlSyntax = true;
//apiContent.Add(refItem);
//documenter.AddGroup(apiGroup);
ReferenceLinkSource linkSource = new ReferenceLinkSource();
refItem = new ReferenceItem(projectDoc, null);
//refItem.XamlSyntax = true;
linkSource.Add(refItem);
refItem = new ReferenceItem(
Path.Combine(outputDir, "Tests.Shapes.xml"),
Path.Combine(outputDir, "Tests.Shapes.dll"));
//refItem.XamlSyntax = true;
linkSource.Add(refItem);
refItem = new ReferenceItem(
Path.Combine(outputDir, "Tests.Geometries.xml"),
Path.Combine(outputDir, "Tests.Geometries.dll"));
//refItem.XamlSyntax = true;
linkSource.Add(refItem);
engineSettings.AddLinkSource(linkSource);
}