Sandcastle Help File Builder Documentation
Documentation
Add a new item to the collection
Definition
Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0
The DocumentationSource added to the project or the existing item if the filename already exists in the collection.
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0
C#
public DocumentationSource Add(
string filename,
string config,
string platform,
string targetFramework,
bool subFolders
)VB
Public Function Add (
filename As String,
config As String,
platform As String,
targetFramework As String,
subFolders As Boolean
) As DocumentationSourceC++
public:
DocumentationSource^ Add(
String^ filename,
String^ config,
String^ platform,
String^ targetFramework,
bool subFolders
)F#
member Add :
filename : string *
config : string *
platform : string *
targetFramework : string *
subFolders : bool -> DocumentationSource Parameters
- filename String
- The filename to add
- config String
- The configuration to use for projects
- platform String
- The platform to use for projects
- targetFramework String
- The target framework to use for projects
- subFolders Boolean
- True to include subfolders, false to only search the top-level folder
Return Value
DocumentationSourceThe DocumentationSource added to the project or the existing item if the filename already exists in the collection.
Remarks
The DocumentationSource constructor is internal so that we control creation
of the items and can associate them with the project.