mike-jumper commented on a change in pull request #159: GUACAMOLE-465: 
beginning to support new codecs and containers
URL: https://github.com/apache/guacamole-server/pull/159#discussion_r371048492
 
 

 ##########
 File path: src/guacenc/ffmpeg-compat.h
 ##########
 @@ -78,5 +78,70 @@
  */
 int guacenc_avcodec_encode_video(guacenc_video* video, AVFrame* frame);
 
+/**
+ * Creates and sets up the AVCodecContext for the appropriate version
+ * of libavformat installed
+ *
+ * @param stream
+ *     The open AVStream
 
 Review comment:
   The format Doxygen-style comments that are used within guacamole-server to 
document the various functions is similar to JavaDoc and JSDoc in the need for 
periods, etc. The descriptions of parameters and the description of the 
function all need to end with a final `.`. For example:
   
   ```c
   /**
    * Creates and sets up the AVCodecContext for the appropriate version
    * of libavformat installed.
    *
    * @param stream
    *     The open AVStream.
   ```

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

Reply via email to