AdditionalNoticesPlugIn Class

This plug-in class is designed to add additional notice definitions to the selected presentation style

Definition

Namespace: SandcastleBuilder.PlugIns
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2025.3.22.0

C#View SourceRequest Example
public sealed class AdditionalNoticesPlugIn : IPlugIn, 
	IDisposable

VBView SourceRequest Example
Public NotInheritable Class AdditionalNoticesPlugIn
	Implements IPlugIn, IDisposable

C++View SourceRequest Example
public ref class AdditionalNoticesPlugIn sealed : IPlugIn, 
	IDisposable

F#View SourceRequest Example
[<SealedAttribute>]
type AdditionalNoticesPlugIn = 
    class
        interface IPlugIn
        interface IDisposable
    end

Inheritance: Object AdditionalNoticesPlugIn

Implements: IPlugIn, IDisposable

Remarks

Notices are messages that appear at the top of topics and in tags on the member list pages to indicate special situations such as preliminary, obsolete, or experimental APIs. They are detected based on the presence of an XML comment element or attribute on the type or member.

Constructors

AdditionalNoticesPlugIn

Initializes a new instance of the AdditionalNoticesPlugIn class

Properties

ExecutionPoints

This read-only property returns a collection of execution points that define when the plug-in should be invoked during the build process.

Methods

Dispose	This implements the Dispose() interface to properly dispose of the plug-in object
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Execute	This method is used to execute the plug-in during the build process
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
Initialize	This method is used to initialize the plug-in at the start of the build process
ToString	Returns a string that represents the current object. (Inherited from Object)