From: Richard Kettlewell Date: Sun, 7 Aug 2011 12:57:44 +0000 (+0100) Subject: protogen: missing generated docs X-Git-Tag: branchpoint-5.1~22^2~1 X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/commitdiff_plain/1f60835b6e1b2ec47155fe46ebfd0cca8be90a4f protogen: missing generated docs --- diff --git a/lib/client-stubs.h b/lib/client-stubs.h index 8b0f4c5..07312b4 100644 --- a/lib/client-stubs.h +++ b/lib/client-stubs.h @@ -539,6 +539,7 @@ int disorder_revoke(disorder_client *c); * * @param c Client * @param addressp Where to store hostname or address + * @param portp Where to store service name or port number * @return 0 on success, non-0 on error */ int disorder_rtp_address(disorder_client *c, char **addressp, char **portp); @@ -759,6 +760,7 @@ int disorder_set_volume(disorder_client *c, long left, long right); * * @param c Client * @param leftp Left channel volume + * @param rightp Right channel volume * @return 0 on success, non-0 on error */ int disorder_get_volume(disorder_client *c, long *leftp, long *rightp); diff --git a/scripts/protocol b/scripts/protocol index c7ef728..9e7be9d 100755 --- a/scripts/protocol +++ b/scripts/protocol @@ -194,6 +194,7 @@ sub c_param_docs { sub c_return_docs { my $returns = shift; return () unless defined $returns; + my @docs = (); for my $return (@$returns) { my $type = $return->[0]; my $name = $return->[1]; @@ -203,20 +204,25 @@ sub c_return_docs { or $type eq 'integer' or $type eq 'time' or $type eq 'boolean') { - return (" * \@param ${name}p $descr\n"); + push(@docs, + " * \@param ${name}p $descr\n"); } elsif($type eq 'list' or $type eq 'body') { - return (" * \@param ${name}p $descr\n", - " * \@param n${name}p Number of elements in ${name}p\n"); + push(@docs, + " * \@param ${name}p $descr\n", + " * \@param n${name}p Number of elements in ${name}p\n"); } elsif($type eq 'pair-list') { - return (" * \@param ${name}p $descr\n"); + push(@docs, + " * \@param ${name}p $descr\n"); } elsif($type eq 'queue' or $type eq 'queue-one') { - return (" * \@param ${name}p $descr\n"); + push(@docs, + " * \@param ${name}p $descr\n"); } elsif($type eq 'user') { - return (); + # nothing } else { die "$0: c_return_docs: unknown type '$type'\n"; } } + return @docs; } # simple(CMD, SUMMARY, DETAIL,