aboutsummaryrefslogtreecommitdiff
path: root/toolsrc/include/vcpkg_Build.h
diff options
context:
space:
mode:
authorRobert Schumacher <roschuma@microsoft.com>2017-05-24 15:54:12 -0700
committerRobert Schumacher <roschuma@microsoft.com>2017-05-24 15:54:12 -0700
commit81fe73d02061866c2188fc8d9e13f9990a20d64d (patch)
tree935ebe35cccf3a94816553e7db311ed2cfad8fc8 /toolsrc/include/vcpkg_Build.h
parenta5eb44f1a62315f673b8f2f48c1d3895dcceabda (diff)
downloadvcpkg-81fe73d02061866c2188fc8d9e13f9990a20d64d.tar.gz
vcpkg-81fe73d02061866c2188fc8d9e13f9990a20d64d.zip
[vcpkg] Add comments
Diffstat (limited to 'toolsrc/include/vcpkg_Build.h')
-rw-r--r--toolsrc/include/vcpkg_Build.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/toolsrc/include/vcpkg_Build.h b/toolsrc/include/vcpkg_Build.h
index 45b3ff1e8..e0a5ae1ce 100644
--- a/toolsrc/include/vcpkg_Build.h
+++ b/toolsrc/include/vcpkg_Build.h
@@ -33,8 +33,14 @@ namespace vcpkg::Build
std::string create_error_message(const BuildResult build_result, const PackageSpec& spec);
std::string create_user_troubleshooting_message(const PackageSpec& spec);
+ /// <summary>
+ /// Settings from the triplet file which impact the build environment and post-build checks
+ /// </summary>
struct PreBuildInfo
{
+ /// <summary>
+ /// Runs the triplet file in a "capture" mode to create a PreBuildInfo
+ /// </summary>
static PreBuildInfo from_triplet_file(const VcpkgPaths& paths, const Triplet& triplet);
std::string target_architecture;