From 81fe73d02061866c2188fc8d9e13f9990a20d64d Mon Sep 17 00:00:00 2001
From: Robert Schumacher <roschuma@microsoft.com>
Date: Wed, 24 May 2017 15:54:12 -0700
Subject: [vcpkg] Add comments

---
 toolsrc/include/BinaryParagraph.h | 3 +++
 toolsrc/include/SourceParagraph.h | 3 +++
 toolsrc/include/StatusParagraph.h | 3 +++
 toolsrc/include/vcpkg_Build.h     | 6 ++++++
 4 files changed, 15 insertions(+)

(limited to 'toolsrc/include')

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;
-- 
cgit v1.2.3