[x265] [PATCH] doc: Cleanup api.rst, and update comments in x265.h

[Pradeep Ramachandran]

# HG changeset patch
# User Pradeep Ramachandran <pradeep at multicorewareinc.com>
# Date 1510843786 -19800
#      Thu Nov 16 20:19:46 2017 +0530
# Node ID 90ef3cb7af23dfd3fcf98825b32d661481ac96c1
# Parent  5b0d7c668968aa6d1b653598e08b72f2b43f32e3
doc: Cleanup api.rst, and update comments in x265.h

diff -r 5b0d7c668968 -r 90ef3cb7af23 doc/reST/api.rst
--- a/doc/reST/api.rst	Mon Nov 13 12:20:50 2017 +0530
+++ b/doc/reST/api.rst	Thu Nov 16 20:19:46 2017 +0530
@@ -208,18 +208,19 @@
      *     This API must be called after(poc >= lookaheadDepth + bframes + 2) condition check */
      int x265_get_ref_frame_list(x265_encoder *encoder, x265_picyuv**, x265_picyuv**, int, int);
  
-**x265_encoder_ctu_info**
-       /* x265_encoder_ctu_info:
-        *    Copy CTU information such as ctu address and ctu partition structure of all
-        *    CTUs in each frame. The function is invoked only if "--ctu-info" is enabled and
-        *    the encoder will wait for this copy to complete if enabled.
-        */
+**x265_encoder_ctu_info** may be used to provide additional CTU-specific information to the encoder::
+
+    /* x265_encoder_ctu_info:
+     *    Copy CTU information such as ctu address and ctu partition structure of all
+     *    CTUs in each frame. The function is invoked only if "--ctu-info" is enabled and
+     *    the encoder will wait for this copy to complete if enabled.*/
+    int x265_encoder_ctu_info(x265_encoder *encoder, int poc, x265_ctu_info_t** ctu);
 
 **x265_set_analysis_data()** may be used to recive analysis information from external application::
 
     /* x265_set_analysis_data:
-     *     set the analysis data,
-     *     returns negative on error, 0 access unit were output. */
+     *     set the analysis data. The incoming analysis_data structure is assumed to be AVC-sized blocks.
+     *     returns negative on error, 0 access unit were output.*/
      int x265_set_analysis_data(x265_encoder *encoder, x265_analysis_data *analysis_data, int poc, uint32_t cuBytes);
 
 Pictures
diff -r 5b0d7c668968 -r 90ef3cb7af23 source/x265.h
--- a/source/x265.h	Mon Nov 13 12:20:50 2017 +0530
+++ b/source/x265.h	Thu Nov 16 20:19:46 2017 +0530
@@ -1732,8 +1732,6 @@
  *    the encoder will wait for this copy to complete if enabled.
  */
 int x265_encoder_ctu_info(x265_encoder *, int poc, x265_ctu_info_t** ctu);
-/* x265_cleanup:
- *       release library static allocations, reset configured CTU size */
 
 /* x265_get_slicetype_poc_and_scenecut:
  *     get the slice type, poc and scene cut information for the current frame,
@@ -1747,10 +1745,12 @@
 int x265_get_ref_frame_list(x265_encoder *encoder, x265_picyuv**, x265_picyuv**, int, int);
 
 /* x265_set_analysis_data:
- *     set the analysis data,
+ *     set the analysis data. The incoming analysis_data structure is assumed to be AVC-sized blocks.
  *     returns negative on error, 0 access unit were output. */
 int x265_set_analysis_data(x265_encoder *encoder, x265_analysis_data *analysis_data, int poc, uint32_t cuBytes);
 
+/* x265_cleanup:
+ *       release library static allocations, reset configured CTU size */
 void x265_cleanup(void);
 
 /* Open a CSV log file. On success it returns a file handle which must be passed