home *** CD-ROM | disk | FTP | other *** search
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>NDoc.Documenter.Msdn</name>
- </assembly>
- <members>
- <member name="T:NDoc.Documenter.Msdn.ExternalHtmlProvider">
- <summary>
- Used as an extension object to the xslt processor to allow
- retrieving user-provided raw html.
- </summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.ExternalHtmlProvider.#ctor(NDoc.Documenter.Msdn.MsdnDocumenterConfig,System.String)">
- <summary>
- Contructor.
- </summary>
- <param name="config">MsdnDocumenterConfig from which the property values can be retrieved.</param>
- <param name="fileName">Name of the HTML file that is currently being generated by the xslt processor.</param>
- </member>
- <member name="M:NDoc.Documenter.Msdn.ExternalHtmlProvider.GetHeaderHtml(System.String)">
- <summary>
- Retrieves user-provided raw html to use as page headers.
- </summary>
- <param name="topicTitle">The title of the current topic.</param>
- <returns></returns>
- </member>
- <member name="M:NDoc.Documenter.Msdn.ExternalHtmlProvider.GetFooterHtml(System.String,System.String,System.String)">
- <summary>
- Retrieves user-provided raw html to use as page footers.
- </summary>
- <param name="assemblyName">The name of the assembly for the current topic.</param>
- <param name="assemblyVersion">The version of the assembly for the current topic.</param>
- <param name="topicTitle">The title of the current topic.</param>
- <returns></returns>
- </member>
- <member name="T:NDoc.Documenter.Msdn.HtmlHelp">
- <summary>HTML Help file utilities.</summary>
- <remarks>This class is used by the MsdnHelp documenter
- to create the files needed by the HTML Help compiler.</remarks>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.#ctor(System.String,System.String,System.String,System.Boolean)">
- <summary>Initializes a new instance of the HtmlHelp class.</summary>
- <param name="directoryName">The directory to write the HTML Help files to.</param>
- <param name="projectName">The name of the HTML Help project.</param>
- <param name="defaultTopic">The default topic for the compiled HTML Help file.</param>
- <param name="generateTocOnly">When true, HtmlHelp only outputs the HHC file and does not compile the CHM.</param>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.GetPathToProjectFile">
- <summary>Gets the path the the HHP file.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.GetPathToContentsFile">
- <summary>Gets the path the the HHC file.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.GetPathToIndexFile">
- <summary>Gets the path the the HHK file.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.GetPathToLogFile">
- <summary>Gets the path the the LOG file.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.GetPathToCompiledHtmlFile">
- <summary>Gets the path the the CHM file.</summary>
- <returns>The path to the CHM file.</returns>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.OpenProjectFile">
- <summary>Opens an HTML Help project file for writing.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.AddFileToProject(System.String)">
- <summary>Adds a file to the HTML Help project file.</summary>
- <param name="filename">The filename to add.</param>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.CloseProjectFile">
- <summary>Closes the HTML Help project file.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.OpenContentsFile(System.String,System.Boolean)">
- <summary>Opens a HTML Help contents file for writing.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.OpenBookInContents">
- <summary>Creates a new "book" in the HTML Help contents file.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.AddFileToContents(System.String,System.String)">
- <summary>Adds a file to the contents file.</summary>
- <param name="headingName">The name as it should appear in the contents.</param>
- <param name="htmlFilename">The filename for this entry.</param>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.AddFileToContents(System.String,System.String,NDoc.Documenter.Msdn.HtmlHelpIcon)">
- <summary>Adds a file to the contents file.</summary>
- <param name="headingName">The name as it should appear in the contents.</param>
- <param name="htmlFilename">The filename for this entry.</param>
- <param name="icon">The image for this entry.</param>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.CloseBookInContents">
- <summary>Closes the last opened "book" in the contents file.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.CloseContentsFile">
- <summary>Closes the contents file.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.WriteEmptyIndexFile">
- <summary>Writes an empty index file.</summary>
- <remarks>The HTML Help Compiler will complain if this file doesn't exist.</remarks>
- </member>
- <member name="M:NDoc.Documenter.Msdn.HtmlHelp.CompileProject">
- <summary>Compiles the HTML Help project.</summary>
- </member>
- <member name="P:NDoc.Documenter.Msdn.HtmlHelp.DirectoryName">
- <summary>Gets the directory name containing the HTML Help files.</summary>
- </member>
- <member name="P:NDoc.Documenter.Msdn.HtmlHelp.ProjectName">
- <summary>Gets the HTML Help project name.</summary>
- </member>
- <member name="P:NDoc.Documenter.Msdn.HtmlHelp.IncludeFavorites">
- <summary>Gets or sets the IncludeFavorites property.</summary>
- <remarks>
- Setting this to <see langword="true" /> will include the "favorites"
- tab in the compiled HTML Help file.
- </remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.HtmlHelp.BinaryTOC">
- <summary>Gets or sets the BinaryTOC property.</summary>
- <remarks>
- Setting this to <see langword="true" /> will force the compiler
- to create a binary TOC in the chm file.
- </remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.HtmlHelp.LangID">
- <summary>
-
- </summary>
- </member>
- <member name="P:NDoc.Documenter.Msdn.HtmlHelp.DefaultTopic">
- <summary>Gets or sets the DefaultTopic property.</summary>
- </member>
- <member name="P:NDoc.Documenter.Msdn.HtmlHelp.HtmlHelpCompiler">
- <summary>Gets the path to the Html Help Compiler.</summary>
- <exception cref="T:System.PlatformNotSupportedException">NDoc is running on unix.</exception>
- </member>
- <member name="T:NDoc.Documenter.Msdn.HtmlHelpIcon">
- <summary>
- HtmlHelp v1 TOC icons
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Book">
- <summary>
- Contents Book
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Folder">
- <summary>
- Contents Folder
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Question">
- <summary>
- Page with Question Mark
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Page">
- <summary>
- Standard Blank Page
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.World">
- <summary>
- World
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.WorldInternetExplorer">
- <summary>
- World w IE icon
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Information">
- <summary>
- Information
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Shortcut">
- <summary>
- Shortcut
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.BookPage">
- <summary>
- BookPage
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Envelope">
- <summary>
- Envelope
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Person">
- <summary>
- Person
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Sound">
- <summary>
- Sound
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Disc">
- <summary>
- Disc
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Video">
- <summary>
- Video
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Steps">
- <summary>
- Steps
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.LightBulb">
- <summary>
- LightBulb
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Pencil">
- <summary>
- Pencil
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.HtmlHelpIcon.Tool">
- <summary>
- Tool
- </summary>
- </member>
- <member name="T:NDoc.Documenter.Msdn.MsdnDocumenter">
- <summary>The MsdnDocumenter class.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnDocumenter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NDoc.Documenter.Msdn.MsdnDocumenter"/>
- class.
- </summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnDocumenter.Clear">
- <summary>See IDocumenter.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnDocumenter.CanBuild(NDoc.Core.Project,System.Boolean)">
- <summary>See <see cref="T:NDoc.Core.IDocumenter"/>.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnDocumenter.Build(NDoc.Core.Project)">
- <summary>See <see cref="T:NDoc.Core.IDocumenter"/>.</summary>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenter.MainOutputFile">
- <summary>See <see cref="T:NDoc.Core.IDocumenter"/>.</summary>
- </member>
- <member name="T:NDoc.Documenter.Msdn.MsdnDocumenter.FilteringXmlTextReader">
- <summary>
- This custom reader is used to load the XmlDocument. It removes elements that are not required *before*
- they are loaded into memory, and hence lowers memory requirements significantly.
- </summary>
- </member>
- <member name="T:NDoc.Documenter.Msdn.MsdnDocumenterConfig">
- <summary>The MsdnDocumenterConfig class.</summary>
- <remarks>
- <para>The MSDN documenter creates a compiled HTML help version 1 help file (CHM).</para>
- </remarks>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnDocumenterConfig.#ctor">
- <summary>Initializes a new instance of the MsdnHelpConfig class.</summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnDocumenterConfig.#ctor(System.String)">
- <summary>
- Constructor used by derived classes
- </summary>
- <param name="name">The name of the derived class config</param>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnDocumenterConfig.HandleUnknownPropertyType(System.String,System.String)">
- <summary>
-
- </summary>
- <param name="name"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.OutputDirectory">
- <summary>Gets or sets the OutputDirectory property.</summary>
- <remarks>The directory in which .html files and the .chm files will be generated.</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.HtmlHelpName">
- <summary>Gets or sets the HtmlHelpName property.</summary>
- <remarks>The HTML Help project file and the compiled HTML Help file
- use this property plus the appropriate extension as names.</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.Title">
- <summary>Gets or sets the Title property.</summary>
- <remarks>This is the title displayed at the top of every page.</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.ShowVisualBasic">
- <summary>Gets or sets the ShowVisualBasic property.</summary>
- <remarks>This is a temporary property until we get a working
- language filter in the output like MSDN.</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.OutputTarget">
- <summary>Gets or sets the OutputTarget property.</summary>
- <remarks>Sets the output type to HTML Help (.chm) or Web or both.</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.SdkLinksOnWeb">
- <summary>Gets or sets the SdkLinksOnWeb property.</summary>
- <remarks>
- </remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.IncludeFavorites">
- <summary>Gets or sets the IncludeFavorites property.</summary>
- <remarks>Turning this flag on will include a Favorites tab in the HTML Help file.</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.RootPageTOCName">
- <summary>Gets or sets the RootPageTOCName property.</summary>
- <remarks>The name for the table-of-contents entry corresponding
- to the root page.
- If this is not specified and RootPageFileName is, then
- the TOC entry will be 'Overview'.</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.RootPageFileName">
- <summary>Gets or sets the RootPageFileName property.</summary>
- <remarks>The name of an html file to be included as the root home page. "</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.RootPageContainsNamespaces">
- <summary>Gets or sets the RootPageContainsNamespaces property.</summary>
- <remarks>If true, the Root Page will be made the container
- of the namespaces in the table-of-contents.
- If false, the Root Page will be made a peer of
- the namespaces in the table-of-contents.</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.BinaryTOC">
- <summary>Gets or sets the BinaryToc property.</summary>
- <remarks>Create a binary table-of-contents file.
- This can significantly reduce the amount of time
- required to load a very large help document.</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.HeaderHtml">
- <summary>Gets or sets the HeaderHtml property.</summary>
- <remarks>Raw HTML that is used as a page header instead of the default blue banner.
- "%FILE_NAME%\" is dynamically replaced by the name of the file for the current html page.
- "%TOPIC_TITLE%\" is dynamically replaced by the title of the current page.</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.FooterHtml">
- <summary>Gets or sets the FooterHtml property.</summary>
- <remarks>Raw HTML that is used as a page footer instead of the default footer.
- "%FILE_NAME%\" is dynamically replaced by the name of the file for the current html page.
- "%ASSEMBLY_NAME%\" is dynamically replaced by the name of the assembly for the current page.
- "%ASSEMBLY_VERSION%\" is dynamically replaced by the version of the assembly for the current page.
- "%TOPIC_TITLE%\" is dynamically replaced by the title of the current page.</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.FilesToInclude">
- <summary>Gets or sets the FilesToInclude property.</summary>
- <remarks>Specifies external files that must be included
- in the compiled CHM file. Multiple files must be separated by a pipe ('|').</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.AdditionalContentResourceDirectory">
- <summary>Gets or sets the AdditionalContentResourceDirectory property</summary>
- <remarks>Directory that contains resources (images etc.) used by the additional content pages.
- This directory will be recursively compiled into the help file.</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.ExtensibilityStylesheet">
- <summary>Gets or sets the ExtensibilityStylesheet property</summary>
- <remarks>Path to an xslt stylesheet that contains templates for documenting extensibility tags.</remarks>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnDocumenterConfig.LangID">
- <summary>Gets or sets the LangID property</summary>
- <remarks>The language ID of the locale used by the compiled helpfile</remarks>
- </member>
- <member name="T:NDoc.Documenter.Msdn.OutputType">
- <summary>
- Defines the output types for this documenter.
- </summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.OutputType.HtmlHelp">
- <summary>Output only an HTML Help file (.chm).</summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.OutputType.Web">
- <summary>Output only Web pages.</summary>
- </member>
- <member name="F:NDoc.Documenter.Msdn.OutputType.HtmlHelpAndWeb">
- <summary>Output both HTML Help and Web.</summary>
- </member>
- <member name="T:NDoc.Documenter.Msdn.MsdnWorkspace">
- <summary>
- Summary description for MsdnWorkspace.
- </summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnWorkspace.#ctor(System.String)">
- <summary>
- Contructs a new instance of the MsdnWorkspace class
- </summary>
- <param name="rootDir">The location to create the workspace</param>
- </member>
- <member name="T:NDoc.Documenter.Msdn.MsdnXsltUtilities">
- <summary>
- Provides an extension object for the xslt transformations.
- </summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnXsltUtilities.#ctor(System.Collections.Specialized.StringDictionary,System.Collections.Specialized.StringDictionary,NDoc.Core.Reflection.SdkVersion,System.String,System.Boolean,System.Text.Encoding)">
- <summary>
- Initializes a new instance of class MsdnXsltUtilities
- </summary>
- <param name="fileNames">A StringDictionary holding id to file name mappings.</param>
- <param name="elemNames">A StringDictionary holding id to element name mappings</param>
- <param name="linkToSdkDocVersion">Specifies the version of the SDK documentation.</param>
- <param name="linkToSdkDocLangauge">Specifies the version of the SDK documentation.</param>
- <param name="SdkLinksOnWeb">Specifies if links should be to ms online documentation.</param>
- <param name="fileEncoding">Specifies if links should be to ms online documentation.</param>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnXsltUtilities.Reset">
- <summary>
- Reset Overload method checking state.
- </summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnXsltUtilities.GetHRef(System.String)">
- <summary>
- Returns an HRef for a CRef.
- </summary>
- <param name="cref">CRef for which the HRef will be looked up.</param>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnXsltUtilities.GetName(System.String)">
- <summary>
- Returns a name for a CRef.
- </summary>
- <param name="cref">CRef for which the name will be looked up.</param>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnXsltUtilities.HasSimilarOverloads(System.String)">
- <summary>
- Looks up, whether a member has similar overloads, that have already been documented.
- </summary>
- <param name="description">A string describing this overload.</param>
- <returns>true, if there has been a member with the same description.</returns>
- <remarks>
- <para>On the members pages overloads are cumulated. Instead of adding all overloads
- to the members page, a link is added to the members page, that points
- to an overloads page.</para>
- <para>If for example one overload is public, while another one is protected,
- we want both to appear on the members page. This is to make the search
- for suitable members easier.</para>
- <para>This leads us to the similarity of overloads. Two overloads are considered
- similar, if they have the same name, declaring type, access (public, protected, ...)
- and contract (static, non static). The description contains these four attributes
- of the member. This means, that two members are similar, when they have the same
- description.</para>
- <para>Asking for the first time, if a member has similar overloads, will return false.
- After that, if asking with the same description again, it will return true, so
- the overload does not need to be added to the members page.</para>
- </remarks>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnXsltUtilities.Replace(System.String,System.String,System.String)">
- <summary>
- Exposes <see cref="M:System.String.Replace(System.Char,System.Char)"/> to XSLT
- </summary>
- <param name="str">The string to search</param>
- <param name="oldValue">The string to search for</param>
- <param name="newValue">The string to replace</param>
- <returns>A new string</returns>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnXsltUtilities.GetLocalizedFrameworkURL(System.String,System.String)">
- <summary>
- returns a localized sdk url if one exists for the <see cref="P:System.Globalization.CultureInfo.CurrentCulture"/>.
- </summary>
- <param name="searchNamespace">base namespace to search for</param>
- <param name="langCode">the localization language code</param>
- <returns>ms-help url for sdk</returns>
- </member>
- <member name="M:NDoc.Documenter.Msdn.MsdnXsltUtilities.GetContentType">
- <summary>
- Gets HTML ContentType for the system's current ANSI code page.
- </summary>
- <returns>ContentType attribute string</returns>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnXsltUtilities.SdkDocBaseUrl">
- <summary>
- Gets the base Url for system types links.
- </summary>
- </member>
- <member name="P:NDoc.Documenter.Msdn.MsdnXsltUtilities.SdkDocExt">
- <summary>
- Gets the page file extension for system types links.
- </summary>
- </member>
- <member name="T:NDoc.Documenter.Msdn.StyleSheetCollection">
- <summary>
- The collection of xslt stylesheets used to generate the Html
- </summary>
- </member>
- <member name="M:NDoc.Documenter.Msdn.StyleSheetCollection.LoadStyleSheets(System.String)">
- <summary>
- Load the predefined set of xslt stylesheets into a dictionary
- </summary>
- <param name="extensibiltyStylesheet"></param>
- <returns>The populated collection</returns>
- </member>
- <member name="P:NDoc.Documenter.Msdn.StyleSheetCollection.Item(System.String)">
- <summary>
- Return a named stylesheet from the collection
- </summary>
- </member>
- </members>
- </doc>
-