[Ffmpeg-devel] [PATCH 00/31] Various Doxygen related patches

[takis.issaris at uhasselt.be]

The following patches move various functions from the source files to the
accompanying header files and doxygenize the existing comments. Only patch 25
does some which is less trivial then the other patches: It turns the combination
of macros and an enum into a simple enum with Doxygen comments (the currently
included description wasn't used anywhere as far as I am aware).

I am sending them as separate patches to ease reviewing and accepting of
individual parts. To keep to annoyance lower, I've put them all in one thread.

Overview of the included patches:
[PATCH 01/31] Doxygenize existing comments
[PATCH 02/31] Move Doxygen docs from src to header
[PATCH 03/31] Move av_shr_i to the header file.
[PATCH 04/31] Move av_cmp_i to the header file.
[PATCH 05/31] Move av_mod_i to the header file.
[PATCH 06/31] Move av_div_i to the header file.
[PATCH 07/31] Move av_int2i to the header file.
[PATCH 08/31] Move av_i2int to the header file.
[PATCH 09/31] Move av_log2_i to the header file.
[PATCH 10/31] Move rtp_get_payload_type() to the header file.
[PATCH 11/31] Move rtp_check_and_send_back_rr() to the header file.
[PATCH 12/31] Move rtp_parse_open() to the header file.
[PATCH 13/31] Move rtp_parse_packet() to the header file.
[PATCH 14/31] Move rtp_set_remote_url() to the header file.
[PATCH 15/31] Move rtp_get_local_port() to the header file.
[PATCH 16/31] Move rtp_get_file_handles() to the header file.
[PATCH 17/31] Doxygenize the comments for the rtp_get_payload_type()
function.
[PATCH 18/31] Doxygenize the comments for the RTP_MAX_SDES definition.
[PATCH 19/31] Doxygenize the comments for the rtp_payload_data_s
structure.
[PATCH 20/31] Doxygenize the comments for the AUHeaders structure.
[PATCH 21/31] Move av_malloc() to the header file.
[PATCH 22/31] Move av_realloc() to the header file.
[PATCH 23/31] Move av_free() to the header file.
[PATCH 24/31] Move av_freep() to the header file.
[PATCH 25/31] Convert macro+enum into a simple enum.
[PATCH 26/31] Doxygenize comments in rtps.h
[PATCH 27/31] Move rtsp.c comments to the header
[PATCH 28/31] Make rtsp_set_callback() comments available to Doxygen
[PATCH 29/31] Move avio comments from source to header file.
[PATCH 30/31] Move aviobuf.c comments to avio.h
[PATCH 31/31] Doxygenize avio.h

 b/libavformat/avformat.h  |  123 +++++++++++++++++++++++-----------------------
 b/libavformat/avio.c      |   14 -----
 b/libavformat/avio.h      |   10 +++
 b/libavformat/aviobuf.c   |   41 ---------------
 b/libavformat/rtp.c       |    1 
 b/libavformat/rtp.h       |    3 -
 b/libavformat/rtpproto.c  |   10 ---
 b/libavformat/rtsp.c      |    1 
 b/libavformat/rtsp.h      |    5 -
 b/libavformat/rtspcodes.h |   28 +++++-----
 b/libavutil/common.h      |    6 ++
 b/libavutil/integer.c     |    4 -
 b/libavutil/integer.h     |    6 +-
 b/libavutil/log.c         |   14 -----
 b/libavutil/log.h         |   15 +++++
 b/libavutil/mem.c         |    6 --
 libavformat/avio.h        |  100 ++++++++++++++++++++++++++++---------
 libavformat/rtp.c         |   20 -------
 libavformat/rtp.h         |   59 +++++++++++++++++-----
 libavformat/rtpproto.c    |   12 ----
 libavformat/rtsp.h        |   26 ++++-----
 libavutil/common.h        |   17 ++++++
 libavutil/integer.c       |   22 --------
 libavutil/integer.h       |   34 ++++++++++--
 libavutil/mem.c           |   17 ------
 25 files changed, 294 insertions(+), 300 deletions(-)


With friendly regards,
Takis