Publishing 2019 R3 content

[platform/upstream/dldt.git] / inference-engine / include / ie_iinfer_request.hpp

diff --git a/inference-engine/include/ie_iinfer_request.hpp b/inference-engine/include/ie_iinfer_request.hpp
index d922f5b..e8dc9ee 100644 (file)
--- a/inference-engine/include/ie_iinfer_request.hpp
+++ b/inference-engine/include/ie_iinfer_request.hpp
@@ -33,12 +33,18 @@ public:
         /** IInferRequest doesn't block or interrupt current thread and immediately returns inference status */
         STATUS_ONLY = 0,
     };
-
+    /**
+     * @brief A shared pointer to the IInferRequest object
+     */
     using Ptr = std::shared_ptr<IInferRequest>;
+    /**
+     * @brief A smart pointer to the IInferRequest object
+     */
     using WeakPtr = std::weak_ptr<IInferRequest>;
 
     /**
      * @brief Sets input/output data to infer
+     *
      * @note: Memory allocation does not happen
      * @param name Name of input or output blob.
      * @param data Reference to input or output blob. The type of a blob must match the network input precision and size.
@@ -49,6 +55,7 @@ public:
 
     /**
      * @brief Gets input/output data for inference
+     *
      * @note: Memory allocation does not happen
      * @param name Name of input or output blob.
      * @param data Reference to input or output blob. The type of Blob must match the network input precision and size.
@@ -59,6 +66,7 @@ public:
 
     /**
      * @brief Infers specified input(s) in synchronous mode
+     *
      * @note blocks all methods of IInferRequest while request is ongoing (running or waiting in queue)
      * @param resp Optional: pointer to an already allocated object to contain information in case of failure
      * @return Status code of the operation: OK (0) for success
@@ -67,6 +75,7 @@ public:
 
     /**
      * @brief Queries performance measures per layer to get feedback of what is the most time consuming layer
+     *
      * @note: not all plugins provide meaningful data
      * @param perfMap Map of layer names to profiling information for that layer
      * @param resp Optional: pointer to an already allocated object to contain information in case of failure
@@ -77,6 +86,7 @@ public:
 
     /**
      * @brief Waits for the result to become available. Blocks until specified millis_timeout has elapsed or the result becomes available, whichever comes first.
+     *
      * @param millis_timeout Maximum duration in milliseconds to block for
      * @note There are special cases when millis_timeout is equal some value of the WaitMode enum:
      * * STATUS_ONLY - immediately returns inference status (IInferRequest::RequestStatus). It does not block or interrupt current thread
@@ -88,6 +98,7 @@ public:
 
     /**
      * @brief Starts inference of specified input(s) in asynchronous mode
+     *
      * @note: It returns immediately. Inference starts also immediately
      * @param resp Optional: a pointer to an already allocated object to contain extra information of a failure (if occurred)
      * @return Enumeration of the resulted action: OK (0) for success
@@ -96,6 +107,7 @@ public:
 
     /**
      * @brief Completion callback definition as pointer to a function
+     *
      * @param context Pointer to request for providing context inside callback
      * @param code Completion result status: OK (0) for success
      */
@@ -104,6 +116,7 @@ public:
 
     /**
      * @brief Sets a callback function that will be called on success or failure of asynchronous request
+     *
      * @param callback A function to be called
      * @return Enumeration of the resulted action: OK (0) for success
      */
@@ -111,6 +124,7 @@ public:
 
     /**
      * @brief Gets arbitrary data for the request and stores a pointer to a pointer to the obtained data
+     *
      * @param data Pointer to a pointer to the gotten arbitrary data
      * @param resp Optional: a pointer to an already allocated object to contain extra information of a failure (if occurred)
      * @return Enumeration of the resulted action: OK (0) for success
@@ -119,6 +133,7 @@ public:
 
     /**
      * @brief Sets arbitrary data for the request
+     *
      * @param data Pointer to a pointer to arbitrary data to set
      * @param resp Optional: a pointer to an already allocated object to contain extra information of a failure (if occurred)
      * @return Enumeration of the resulted action: OK (0) for success
@@ -127,6 +142,7 @@ public:
 
     /**
     * @brief Sets new batch size when dynamic batching is enabled in executable network that created this request.
+     *
     * @param batch_size new batch size to be used by all the following inference calls for this request.
     * @param resp Optional: a pointer to an already allocated object to contain extra information of a failure (if occurred)
     * @return Enumeration of the resulted action: OK (0) for success