NamespaceSummaryItemCollectionAdd(String, Boolean, Boolean, String) Method

Add a new item to the collection

Definition

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0

public NamespaceSummaryItem Add(
	string name,
	bool isGroup,
	bool isDocumented,
	string summary
)

Public Function Add ( 
	name As String,
	isGroup As Boolean,
	isDocumented As Boolean,
	summary As String
) As NamespaceSummaryItem

public:
NamespaceSummaryItem^ Add(
	String^ name, 
	bool isGroup, 
	bool isDocumented, 
	String^ summary
)

member Add : 
        name : string * 
        isGroup : bool * 
        isDocumented : bool * 
        summary : string -> NamespaceSummaryItem

name String: The namespace name
isGroup Boolean: True if this is a grouping namespace, false if this is normal namespace
isDocumented Boolean: True for documented, false for not documented
summary String: The summary text

NamespaceSummaryItem
The NamespaceSummaryItem added to the project. If the namespace already exists in the collection, the existing item is returned.

The NamespaceSummaryItem constructor is internal so that we control creation of the items and can associate them with the project.