documentationfile
Enables C# xmlDocumentationFile
The xmlDocumentationFile option is used to include XML comments in a DLL that has been included in a .NET framework or another C# project. These XML comments can then be referenced by other projects when placed alongside the corresponding SharedLib.
This feature sets the documentationfile option in a C# project's .csproj file for each respective configuration
Usage
To use xmlDocumentationFile, add the following line to your project configuration in your premake script:
documentationfile("targetdir")
Parameters
targetdir is the directory where the documentation file should be placed after building the project using visual studio.
Examples
When you set documentationFile to true, the following filepath will be generated:
%{targetdir}/%{prj.name}.xml
documentationfile(true)
If you specify a custom target directory like this:
documentationfile("%{prj.location}/bin/test")
the following filepath will be generated:
bin\test\%{prj.name}.xml
Applies To
Project configurations.
Availability
Premake 5.0 beta3 or later.
Visual studio is the only toolset currently supported.
Warning
It's recommended to use documentationfile(true) because Visual Studio's intellisense will not detect the XML file if its name is not the same as the SharedLib.
See Also
For more information on XML documentation in C#, refer to: