GenerateInheritedDocs Class

This class represents the tool that scans XML comments files for <inheritdoc /> tags and produces a new XML comments file containing the inherited documentation for use by Sandcastle.

Inheritance Hierarchy

SystemObject
Microsoft.Build.UtilitiesTask
SandcastleBuilder.InheritedDocumentationGenerateInheritedDocs

Namespace: SandcastleBuilder.InheritedDocumentation
Assembly: GenerateInheritedDocs (in GenerateInheritedDocs.exe) Version: 2014.11.22.0

Syntax

C++

Copy

public class GenerateInheritedDocs : Task

Public Class GenerateInheritedDocs
	Inherits Task

public ref class GenerateInheritedDocs : public Task

type GenerateInheritedDocs =  
    class
        inherit Task
    end

The GenerateInheritedDocs type exposes the following members.

Constructors

	Name	Description
	GenerateInheritedDocs	Initializes a new instance of the GenerateInheritedDocs class

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	This is used to execute the task and generate the inherited documentation. (Overrides TaskExecute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Main	Main program entry point
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	BuildEngine	Gets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.)
	BuildEngine2	Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.)
	BuildEngine3	Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.)
	ConfigurationFile	This is used to set the configuration file to use from the MSBuild project file
	HelpKeywordPrefix	Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.)
	HostObject	Gets or sets the host object associated with the task. (Inherited from Task.)
	Log	Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
	TaskResources	Gets or sets the culture-specific resources associated with the task. (Inherited from Task.)

Top

Reference

SandcastleBuilder.InheritedDocumentation Namespace