Skip to content

Commit 71a9c8c

Browse files
committed
doxygen2man: Tidy RETURN VALUE
1 parent d1bbe1e commit 71a9c8c

File tree

2 files changed

+21
-7
lines changed

2 files changed

+21
-7
lines changed

docs/Makefile.am

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ dist_man_MANS = man8/qb-blackbox.8
2525
if HAVE_DOXYGEN
2626
if BUILD_MAN
2727

28-
doxygen2man_flags = -q -i qb/ -o man3/ -m -g -P -H "libqb Programmer's Manual"
28+
doxygen2man_flags = -q -i qb/ -o man3/ -m -g -P -H "libqb Programmer's Manual" -p LIBQB
2929

3030
man3_MANS = \
3131
man3/qb_array_create_2.3 \

doxygen2man/doxygen2man.c

+20-6
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
#include <string.h>
2929
#include <getopt.h>
3030
#include <errno.h>
31+
#include <ctype.h>
3132
#include <libxml/tree.h>
3233
#include <qb/qblist.h>
3334
#include <qb/qbmap.h>
@@ -405,6 +406,17 @@ static int read_structure_from_xml(const char *refid, const char *name)
405406
return ret;
406407
}
407408

409+
static char *allcaps(const char *name)
410+
{
411+
static char buffer[1024] = {'\0'};
412+
int i;
413+
414+
for (i=0; i< strlen(name); i++) {
415+
buffer[i] = toupper(name[i]);
416+
}
417+
buffer[strlen(name)] = '\0';
418+
return buffer;
419+
}
408420

409421
static void print_param(FILE *manfile, struct param_info *pi, int field_width, int bold, const char *delimiter)
410422
{
@@ -635,7 +647,7 @@ static void print_manpage(char *name, char *def, char *brief, char *args, char *
635647
/* Off we go */
636648

637649
fprintf(manfile, ".\\\" Automatically generated man page, do not edit\n");
638-
fprintf(manfile, ".TH %s %s %s \"%s\" \"%s\"\n", name, man_section, dateptr, package_name, header);
650+
fprintf(manfile, ".TH %s %s %s \"%s\" \"%s\"\n", allcaps(name), man_section, dateptr, package_name, header);
639651

640652
fprintf(manfile, ".SH NAME\n");
641653
if (brief) {
@@ -712,20 +724,22 @@ static void print_manpage(char *name, char *def, char *brief, char *args, char *
712724
if (returntext) {
713725
fprintf(manfile, ".SH RETURN VALUE\n");
714726
man_print_long_string(manfile, returntext);
715-
}
716-
if (notetext) {
717-
fprintf(manfile, ".SH NOTE\n");
718-
man_print_long_string(manfile, notetext);
727+
fprintf(manfile, ".PP\n");
719728
}
720729

721730
qb_list_for_each(iter, &retval_list) {
722731
pi = qb_list_entry(iter, struct param_info, list);
723732

724-
fprintf(manfile, "\\fB%-*s \\fP\\fI%s\\fP\n", 10, pi->paramname,
733+
fprintf(manfile, "\\fB%-*s \\fP%s\n", 10, pi->paramname,
725734
pi->paramdesc);
726735
fprintf(manfile, ".PP\n");
727736
}
728737

738+
if (notetext) {
739+
fprintf(manfile, ".SH NOTE\n");
740+
man_print_long_string(manfile, notetext);
741+
}
742+
729743
fprintf(manfile, ".SH SEE ALSO\n");
730744
fprintf(manfile, ".PP\n");
731745
fprintf(manfile, ".nh\n");

0 commit comments

Comments
 (0)