[master] Finished merge of trac5480 (user context utils)

diff --git a/src/lib/testutils/user_context_utils.h b/src/lib/testutils/user_context_utils.h
index c815ce578c8f70653f458463699340f965600393..acd43071d31d2efd8ab053679cfb83a5fbd89189 100644 (file)
--- a/src/lib/testutils/user_context_utils.h
+++ b/src/lib/testutils/user_context_utils.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2017 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2017-2018 Internet Systems Consortium, Inc. ("ISC")
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -14,15 +14,26 @@ namespace test {
 
 /// @brief Move comment entries to user-context
 ///
+/// Process an element looking for comment entries in maps and
+/// moving them to user-context entries. As the common case is
+/// no comment and this routine tries to maximize sharing the
+/// standard behavior is just to return the argument unchanged.
+///
 /// @param element
 /// @return a processed copy of element or unmodified element
 isc::data::ElementPtr moveComments(isc::data::ElementPtr element);
 
 /// @brief Extract comment entries from user-context
 ///
+/// Process an element looking for user-context entries carrying
+/// comments and moving these comments at the same level than
+/// user-contexts. As the common case is no comment and this routine
+/// tries to maximize sharing the standard behavior is just to return
+/// the argument unchanged.
+///
 /// @param element
 /// @return a processed copy of element or unmodified element
- isc::data::ElementPtr extractComments(isc::data::ElementPtr element);
+isc::data::ElementPtr extractComments(isc::data::ElementPtr element);
 
 }; // end of isc::test namespace
 }; // end of isc namespace