Namespace Summary Item CollectionAdd(String, Boolean, Boolean, String) Method
Add a new item to the collection
Definition
Namespace: Sandcastle.Core.Project
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
The NamespaceSummaryItem added to the project. If the namespace already exists in the collection, the existing item is returned.
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
C#
public NamespaceSummaryItem Add(
string name,
bool isGroup,
bool isDocumented,
string summary
)VB
Public Function Add (
name As String,
isGroup As Boolean,
isDocumented As Boolean,
summary As String
) As NamespaceSummaryItemC++
public:
NamespaceSummaryItem^ Add(
String^ name,
bool isGroup,
bool isDocumented,
String^ summary
)F#
member Add :
name : string *
isGroup : bool *
isDocumented : bool *
summary : string -> NamespaceSummaryItem Parameters
- 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
Return Value
NamespaceSummaryItemThe 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.