ISandcastleProject.AddFolderToProject Method

Definition

Namespace

Sandcastle.Core.Project

Assembly

Sandcastle.Core.dll

Add a new folder build item to the project

IFileItem AddFolderToProject(string folder)

Parameters

folder string

The folder name

Returns

IFileItem

The new IFileItem.

Exceptions

ArgumentException

This is thrown if the path matches the project root path or is not below it.

Remarks

If the folder does not exist in the project, it is added and created if not already there. If the folder is already part of the project, the existing item is returned.