Edit

XDCMake task

  • Article

Wraps the XML Documentation tool (xdcmake.exe), which merges XML document comment (.xdc) files into an .xml file.

An .xdc file is created when you provide documentation comments in your C++ source code and compile by using the /doc compiler option. For more information, see XDCMake reference, XML Document Generator Tool property pages, and command-line help option (/?) for xdcmake.exe.

Remarks

By default, the xdcmake.exe tool supports a few command-line options. Additional options are supported when you specify the /old command-line option.

Parameters

The following table describes the parameters of the XDCMake task.

Parameter Description
AdditionalDocumentFile Optional String[] parameter.

Specifies one or more additional .xdc files to merge.

For more information, see the Additional Document Files description in XML Document Generator Tool property pages. Also see the /old and /Fs command-line options for xdcmake.exe.
AdditionalOptions Optional String parameter.

A list of options as specified on the command line. For example, /<option1> /<option2> /<option#>. Use this parameter to specify options that are not represented by any other XDCMake task parameter.

For more information, see XDCMake reference, XML Document Generator Tool property pages, and command-line help (/?) for xdcmake.exe.
DocumentLibraryDependencies Optional Boolean parameter.

If true and the current project has a dependency on a static library (.lib) project in the solution, the .xdc files for that library project are included in the .xml file output for the current project.

For more information, see the Document Library Dependencies description in XML Document Generator Tool property pages.
OutputFile Optional String parameter.

Overrides the default output file name. The default name is derived from the name of the first .xdc file that is processed.

For more information, see the /out:<filename> option in XDCMake reference. Also see the /old and /Fo command-line options for xdcmake.exe.
ProjectName Optional String parameter.

The name of the current project.
SlashOld Optional Boolean parameter.

If true, enables additional xdcmake.exe options.

For more information, see the /old command-line option for xdcmake.exe.
Sources Required ITaskItem[] parameter.

Defines an array of MSBuild source file items that can be consumed and emitted by tasks.
SuppressStartupBanner Optional Boolean parameter.

If true, prevents the display of the copyright and version number message when the task starts.

For more information, see the /nologo option in XDCMake reference.
TrackerLogDirectory Optional String parameter.

Specifies the directory for the tracker log.

See also