[trafficserver] branch master updated: Doc: Update comments in InkAPI.cc in the header and for member converters.

[am...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

amc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git


The following commit(s) were added to refs/heads/master by this push:
     new b9b99a1  Doc: Update comments in InkAPI.cc in the header and for member converters.
b9b99a1 is described below

commit b9b99a182dae1a7a4b0c86ea5b2ed69d03e1d92a
Author: Alan M. Carroll <am...@apache.org>
AuthorDate: Fri Aug 10 14:39:07 2018 -0500

    Doc: Update comments in InkAPI.cc in the header and for member converters.
---
 src/traffic_server/InkAPI.cc | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/src/traffic_server/InkAPI.cc b/src/traffic_server/InkAPI.cc
index 6ec2b78..6225ada 100644
--- a/src/traffic_server/InkAPI.cc
+++ b/src/traffic_server/InkAPI.cc
@@ -1,6 +1,6 @@
 /** @file
 
-  Implements callin functions for TSAPI plugins.
+  Implements the Traffic Server C API functions.
 
   @section license License
 
@@ -7811,6 +7811,16 @@ TSSkipRemappingSet(TSHttpTxn txnp, int flag)
   sm->t_state.api_skip_all_remapping = (flag != 0);
 }
 
+/* These are the default converter function sets for management data types. If those are used the
+ * proper converters can be determined here. For other types the converters must be explicitly
+ * specified.
+ *
+ * The purpose of these are to allow configuration elements to not be management types but more
+ * natural types (e.g., an enumeration can be the actual enumeration, not an @c MgmtInt that needs
+ * frequent casting). In effect the converter does the casting for the plugin API, isolating that
+ * to this API handling, with the rest of the code base using the natural types.
+ */
+
 template <typename T>
 inline void *
 _memberp_to_generic(T *ptr, MgmtConverter const *&conv)