Clarify sample comments for protection flow

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: 2 people

mipsdk-protectionapi-cpp-sample-basic/action.cpp

@@ -62,8 +62,8 @@ using mip::ProtectionHandler;
 namespace sample {
 	namespace protection {
 
-		// Constructor accepts mip::ApplicationInfo object and uses it to initialize AuthDelegateImpl.
-		// Specifically, AuthDelegateInfo uses mAppInfo.ApplicationId for AAD client_id value.		
+		// Constructor accepts mip::ApplicationInfo and uses it to initialize AuthDelegateImpl.
+		// AuthDelegateImpl forwards mAppInfo.applicationId as the Microsoft Entra client ID.
 		Action::Action(const mip::ApplicationInfo appInfo,
 			const std::string& username)
 			: mAppInfo(appInfo),
@@ -169,19 +169,18 @@ namespace sample {
 		}
 
 
-		// Function recursively lists all labels available for a user to	std::cout.
+		// List all protection templates available to the current user.
 		void Action::ListTemplates() {
 
-			// If mEngine hasn't been set, call AddNewFileEngine() to load the engine.
+			// If mEngine has not been set, call AddNewProtectionEngine() to load it.
 			if (!mEngine) {			
 				AddNewProtectionEngine();
 			}
 
 			const shared_ptr<ProtectionEngineObserverImpl> engineObserver = std::make_shared<ProtectionEngineObserverImpl>();
 
-			// Create a context to pass to 'ProtectionEngine::GetTemplateListAsync'. That context will be forwarded to the
-			// corresponding ProtectionEngine::Observer methods. In this case, we use promises/futures as a simple way to detect 
-			// the async operation completes synchronously.
+			// Create context for GetTemplatesAsync. The observer receives this same context, and
+			// promises/futures let the sample block until the async call completes.
 			auto loadPromise = std::make_shared<std::promise<vector<shared_ptr<mip::TemplateDescriptor>>>>();
 			std::future<vector<shared_ptr<mip::TemplateDescriptor>>> loadFuture = loadPromise->get_future();
 			mEngine->GetTemplatesAsync(engineObserver, loadPromise);
@@ -205,7 +204,6 @@ namespace sample {
 
 			auto handler = CreateProtectionHandlerForPublishing(descriptor);
 			std::vector<uint8_t> outputBuffer;
-			// std::vector<uint8_t> inputBuffer(static_cast<size_t>(plaintext.size()));
 			std::vector<uint8_t> inputBuffer(plaintext.begin(), plaintext.end());
 
 			outputBuffer.resize(static_cast<size_t>(handler->GetProtectedContentLength(plaintext.size(), true)));
@@ -232,8 +230,6 @@ namespace sample {
 			auto handler = CreateProtectionHandlerForConsumption(serializedLicense);
 			std::vector<uint8_t> outputBuffer(static_cast<size_t>(ciphertext.size()));
 
-				
-			// std::vector<uint8_t> inputBuffer(static_cast<size_t>(plaintext.size()));
 			std::vector<uint8_t> inputBuffer(ciphertext.begin(), ciphertext.end());
 
 			int64_t decryptedSize = handler->DecryptBuffer(

mipsdk-protectionapi-cpp-sample-basic/consent_delegate_impl.cpp

@@ -37,7 +37,7 @@ namespace sample {
 namespace consent {
 
 Consent ConsentDelegateImpl::GetUserConsent(const string& url) {
-  // Accept the consent to connect to the url
+  // This sample runs non-interactively and accepts SDK consent prompts by default.
   std::cout << "This is the consent delegate." << std::endl << std::endl;
 
   std::cout << "SDK will connect to: " << url << std::endl;
@@ -47,8 +47,7 @@ Consent ConsentDelegateImpl::GetUserConsent(const string& url) {
   std::cout << "3) Reject" << std::endl;
   std::cout << "Select an option: ";
   char input;
-  // std::cin >> input;
-  input = 1;
+  input = '2';
 
   switch (input)
   {

mipsdk-protectionapi-cpp-sample-basic/main.cpp

@@ -61,7 +61,7 @@ int RunSample(int argc, char* argv[])
 		}
 	}
 
-	// local variables to store target file and the label that will be applied to the file.
+	// Local variables for template selection and plaintext/ciphertext flow.
 
 	string templateToApply;
 	string plaintext;
@@ -79,21 +79,19 @@ int RunSample(int argc, char* argv[])
 	// Friendly Name should be the name of the application as it should appear in reports.
 	mip::ApplicationInfo appInfo{ clientId,  "MIP SDK Protection Sample for C++", "1.18.0" };
 
-	// All actions for this tutorial project are implemented in samples::policy::Action
-	// Source files are Action.h/cpp.	
-	// Action's constructor takes in the mip::ApplicationInfo object and uses the client ID for auth.
+	// Sample operations are implemented in sample::protection::Action (Action.h/cpp).
+	// Action's constructor accepts app metadata and the username used for authentication.
 	Action action = Action(appInfo, userName);
 
 	while (true)
 	{
 		templateToApply = "";
 
-		// Call action.ListLabels() to display all available labels, then pause.
+		// Display all available protection templates.
 		cout << "*** Template List: " << endl;
 		action.ListTemplates();		
 
-		// Prompt the user to copy the Label ID from a displayed label. This will be stored
-		// then applied later to a file.		
+		// Prompt for a template ID from the list.
 		cout << "Copy a template ID from above to apply to a new string or q to quit." << endl;
 		cout << endl << "Template ID: ";
 		cin >> templateToApply;
@@ -103,15 +101,12 @@ int RunSample(int argc, char* argv[])
 			return 0;
 		}
 
-		// Generate a new protection descriptor and store publishing license
-		
-
-		// Prompt the user to enter a file. A labeled copy of this file will be created.
+		// Prompt for plaintext to encrypt.
 		cout << "Enter some text to encrypt: ";
 		std::getline(std::cin >> std::ws, plaintext);
 
-		// Show action plan
-		cout << "Applying Label ID " + templateToApply + " to: " << endl << plaintext << endl;
+		// Show selected template and input text.
+		cout << "Applying template ID " + templateToApply + " to: " << endl << plaintext << endl;
 
 		// Protect the input string using the previously generated PL.
 		auto publishingLicense = action.ProtectString(plaintext, ciphertext, templateToApply);

mipsdk-protectionapi-cpp-sample-basic/protection_observers.cpp

@@ -15,7 +15,7 @@ using std::vector;
 using std::string;
 using std::exception_ptr;
 
-// Protection Profile Observers
+// Observer callbacks that bridge MIP async APIs to std::promise/std::future.
 void ProtectionProfileObserverImpl::OnLoadSuccess(
 	const shared_ptr<mip::ProtectionProfile>& profile,
 	const shared_ptr<void>& context) {
@@ -67,4 +67,3 @@ void ProtectionEngineObserverImpl::OnGetTemplatesFailure(const exception_ptr& Fa
 	auto loadPromise = static_cast<promise<vector<shared_ptr<mip::TemplateDescriptor>>>*>(context.get());
 	loadPromise->set_exception(Failure);
 };
-