From bfeb09fe37bac3580fdf585934abfecebf946906 Mon Sep 17 00:00:00 2001 From: Kalle Olavi Niemitalo Date: Sun, 18 Nov 2012 19:40:35 +0200 Subject: [PATCH] doxygen: Document dump.c some more Doxygen complained that the cp parameter of dump_output_alloc was not documented. Fix that, and document dump_output_prepare_frame too. --- src/viewer/dump/dump.c | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/viewer/dump/dump.c b/src/viewer/dump/dump.c index 81d0382b4..cb9558ff5 100644 --- a/src/viewer/dump/dump.c +++ b/src/viewer/dump/dump.c @@ -105,6 +105,13 @@ static const unsigned char frame_simplify[FRAME_CHARS_END - FRAME_CHARS_BEGIN] 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 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. * 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. * * @relates dump_output */