History

avcodec/ivi: make comments more Doxygen-friendly

Doxygen eats the newline in the first comment, making it harder to read. Join the lines and add a comma, so source and documentation are equally readable. Doxygen only associates the second comment with cust_dec. The comments for cust_dec and cust_tab make perfect sense without it, so downgrade it to a non-doxygen "//" comment. The third comment was missed by the command in the previous commit, because it (correctly but uniquely) doesn't have a trailing comma.

Andrew Sayers committed 2 years ago

Commit 899e0221 parent 6096c241 file · +3 −4Browse files

Showing the changes to libavcodec (1 of 1 file). Show all

Unified · Split

libavcodec/ivi.h+3−4
@@ -61,18 +61,17 @@ typedef struct IVIHuffDesc { · 60 unmodified lines
61 * macroblock/block huffman table descriptor61 * macroblock/block huffman table descriptor
62 */62 */
63typedef struct IVIHuffTab {63typedef struct IVIHuffTab {
64 int32_t tab_sel; ///< index of one of the predefined tables64 int32_t tab_sel; ///< index of one of the predefined tables, or "7" for custom one
65 /// or "7" for custom one
66 VLC *tab; ///< pointer to the table associated with tab_sel65 VLC *tab; ///< pointer to the table associated with tab_sel
67 66
68 /// the following are used only when tab_sel == 767 // the following are used only when tab_sel == 7
69 IVIHuffDesc cust_desc; ///< custom Huffman codebook descriptor68 IVIHuffDesc cust_desc; ///< custom Huffman codebook descriptor
70 VLC cust_tab; ///< vlc table for custom codebook69 VLC cust_tab; ///< vlc table for custom codebook
71} IVIHuffTab;70} IVIHuffTab;
72 71
73enum {72enum {
74 IVI_MB_HUFF = 0, ///< Huffman table is used for coding macroblocks73 IVI_MB_HUFF = 0, ///< Huffman table is used for coding macroblocks
75 IVI_BLK_HUFF = 1 /// Huffman table is used for coding blocks74 IVI_BLK_HUFF = 1 ///< Huffman table is used for coding blocks
76};75};
77 76
78 77

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t