diff options
| author | Robert Schumacher <roschuma@microsoft.com> | 2017-05-24 15:54:12 -0700 |
|---|---|---|
| committer | Robert Schumacher <roschuma@microsoft.com> | 2017-05-24 15:54:12 -0700 |
| commit | 81fe73d02061866c2188fc8d9e13f9990a20d64d (patch) | |
| tree | 935ebe35cccf3a94816553e7db311ed2cfad8fc8 | |
| parent | a5eb44f1a62315f673b8f2f48c1d3895dcceabda (diff) | |
| download | vcpkg-81fe73d02061866c2188fc8d9e13f9990a20d64d.tar.gz vcpkg-81fe73d02061866c2188fc8d9e13f9990a20d64d.zip | |
[vcpkg] Add comments
| -rw-r--r-- | toolsrc/include/BinaryParagraph.h | 3 | ||||
| -rw-r--r-- | toolsrc/include/SourceParagraph.h | 3 | ||||
| -rw-r--r-- | toolsrc/include/StatusParagraph.h | 3 | ||||
| -rw-r--r-- | toolsrc/include/vcpkg_Build.h | 6 |
4 files changed, 15 insertions, 0 deletions
diff --git a/toolsrc/include/BinaryParagraph.h b/toolsrc/include/BinaryParagraph.h index 90ca8fe9a..1c2edf790 100644 --- a/toolsrc/include/BinaryParagraph.h +++ b/toolsrc/include/BinaryParagraph.h @@ -6,6 +6,9 @@ namespace vcpkg { + /// <summary> + /// Built package metadata + /// </summary> struct BinaryParagraph { BinaryParagraph(); diff --git a/toolsrc/include/SourceParagraph.h b/toolsrc/include/SourceParagraph.h index 8d51b45d4..19f558170 100644 --- a/toolsrc/include/SourceParagraph.h +++ b/toolsrc/include/SourceParagraph.h @@ -15,6 +15,9 @@ namespace vcpkg const std::string& to_string(const Dependency& dep); + /// <summary> + /// Port metadata (CONTROL file) + /// </summary> struct SourceParagraph { SourceParagraph(); diff --git a/toolsrc/include/StatusParagraph.h b/toolsrc/include/StatusParagraph.h index ad913d11b..2d1815dc0 100644 --- a/toolsrc/include/StatusParagraph.h +++ b/toolsrc/include/StatusParagraph.h @@ -23,6 +23,9 @@ namespace vcpkg PURGE }; + /// <summary> + /// Installed package metadata + /// </summary> struct StatusParagraph { StatusParagraph(); 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; |