NamespaceSummaryItemCollection.Add Method

Definition

Namespace

Sandcastle.Core.Project

Assembly

Sandcastle.Core.dll

Add a new item to the collection

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

Parameters

name string

The namespace name

isGroup bool

True if this is a grouping namespace, false if this is normal namespace

isDocumented bool

True for documented, false for not documented

summary string

The summary text

Returns

NamespaceSummaryItem

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

Remarks

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