aniani/elinks
1
0
Fork 0
mirror of https://github.com/rkd77/elinks.git synced 2024-12-04 14:46:47 -05:00
Code

doxygen: Document dump.c some more

Browse Source 
Doxygen complained that the cp parameter of dump_output_alloc was not
documented.  Fix that, and document dump_output_prepare_frame too.
This commit is contained in:
Kalle Olavi Niemitalo 2012-11-18 19:40:35 +02:00 committed by Kalle Olavi Niemitalo
parent 6628a3f477
commit bfeb09fe37
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/viewer/dump/dump.c
View File

@ -105,6 +105,13 @@ static const unsigned char frame_simplify[FRAME_CHARS_END - FRAME_CHARS_BEGIN]
0xC5, '+' , '+' , '#' , 0xDB, 0xDB, 0xDB, 0xDB /* 0xD8...0xDF */ 0xC5, '+' , '+' , '#' , 0xDB, 0xDB, 0xDB, 0xDB /* 0xD8...0xDF */
}; };
/** Initialize dump_output::frame for the specified codepage.
*
* If the codepage does not support all the box-drawing characters
* of CP437, then map them to simpler characters, according to
* frame_simplify.
*
* @relates dump_output */
static void static void
dump_output_prepare_frame(struct dump_output *out, int to_cp) dump_output_prepare_frame(struct dump_output *out, int to_cp)
{ {
@ -152,6 +159,10 @@ dump_output_prepare_frame(struct dump_output *out, int to_cp)
* The string to which the output will be appended. * The string to which the output will be appended.
* Use NULL if the output should go to a file descriptor instead. * Use NULL if the output should go to a file descriptor instead.
* *
* @param cp
* The codepage of the dump. It need not match the codepage
* of the document.
*
* @return The new structure, or NULL on error. * @return The new structure, or NULL on error.
* *
* @relates dump_output */ * @relates dump_output */