From 62b8156a4be17341a77fc49f7e1fc7c582f4ac5b Mon Sep 17 00:00:00 2001 From: David Robillard Date: Sun, 8 Jan 2012 21:24:32 +0000 Subject: Update man page. Sort command line options in help and man page. Fix doxygen warnings about undocumented parameters. git-svn-id: http://svn.drobilla.net/serd/trunk@282 490d8e77-9747-427b-9fa3-0b8f29cee8a0 --- doc/serdi.1 | 29 +++++++++++++++++++---------- serd/serd.h | 7 +++++-- src/serdi.c | 8 ++++---- 3 files changed, 28 insertions(+), 16 deletions(-) diff --git a/doc/serdi.1 b/doc/serdi.1 index 8f654879..d4c447b9 100644 --- a/doc/serdi.1 +++ b/doc/serdi.1 @@ -1,7 +1,7 @@ .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH SERDI 1 "24 May 2011" +.TH SERDI 1 "8 Jan 2012" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -21,8 +21,21 @@ serdi [OPTIONS]... INPUT BASE_URI .SH OPTIONS + +.TP +\fB\-b\fT +Fast bulk output for large serialisations. + +.TP +\fB\-c PREFIX\fR +Chop PREFIX from matching blank node IDs. + +.TP +\fB\-f\fT +Keep full URIs in input (don't qualify). + .TP -\fB\-h\fT, \fB\-\-help\fR +\fB\-h\fT Print the command line options. .TP @@ -33,17 +46,13 @@ Read input in SYNTAX (`turtle' or `ntriples'). \fB\-o SYNTAX\fR Write output in SYNTAX (`turtle' or `ntriples'). -.TP -\fB\-s INPUT\fR -Parse INPUT as a string (terminates options). - .TP \fB\-p PREFIX\fR Add PREFIX to blank node IDs. .TP -\fB\-c PREFIX\fR -Chop PREFIX from matching blank node IDs. +\fB\-s INPUT\fR +Parse INPUT as a string (terminates options). .TP \fB\-v\fR @@ -53,9 +62,9 @@ Display version information and exit. Serdi was written by David Robillard .SH COPYRIGHT -Copyright \(co 2011 David Robillard. +Copyright \(co 2012 David Robillard. .br -License: +License: .br This is free software; you are free to change and redistribute it. .br diff --git a/serd/serd.h b/serd/serd.h index 2380c03e..ca9cb809 100644 --- a/serd/serd.h +++ b/serd/serd.h @@ -416,6 +416,7 @@ serd_node_new_uri(const SerdURI* uri, const SerdURI* base, SerdURI* out); Note that about 16 and 8 fractional digits are required to precisely represent a double and float, respectively. + @param d The value for the new node. @param frac_digits The maximum number of digits after the decimal place. */ SERD_API @@ -434,8 +435,10 @@ serd_node_new_integer(long i); This function can be used to make a serialisable node out of arbitrary binary data, which can be decoded using serd_base64_decode(). - @param wrap_lines If true lines are wrapped at 76 characters to conform - to RFC 2045. + + @param buf Raw binary input data. + @param size Size of @c buf. + @param wrap_lines Wrap lines at 76 characters to conform to RFC 2045. */ SERD_API SerdNode diff --git a/src/serdi.c b/src/serdi.c index e69b226d..909b42ad 100644 --- a/src/serdi.c +++ b/src/serdi.c @@ -30,8 +30,8 @@ int print_version() { printf("serdi " SERD_VERSION " \n"); - printf("Copyright 2011 David Robillard .\n" - "License: \n" + printf("Copyright 2012 David Robillard .\n" + "License: \n" "This is free software; you are free to change and redistribute it." "\nThere is NO WARRANTY, to the extent permitted by law.\n"); return 0; @@ -45,13 +45,13 @@ print_usage(const char* name, bool error) fprintf(os, "Read and write RDF syntax.\n"); fprintf(os, "Use - for INPUT to read from standard input.\n\n"); fprintf(os, " -b Fast bulk output for large serialisations.\n"); + fprintf(os, " -c PREFIX Chop PREFIX from matching blank node IDs\n"); fprintf(os, " -f Keep full URIs in input (don't qualify).\n"); fprintf(os, " -h Display this help and exit\n"); fprintf(os, " -i SYNTAX Input syntax (`turtle' or `ntriples')\n"); fprintf(os, " -o SYNTAX Output syntax (`turtle' or `ntriples')\n"); - fprintf(os, " -s INPUT Parse INPUT as string (terminates options)\n"); fprintf(os, " -p PREFIX Add PREFIX to blank node IDs\n"); - fprintf(os, " -c PREFIX Chop PREFIX from matching blank node IDs\n"); + fprintf(os, " -s INPUT Parse INPUT as string (terminates options)\n"); fprintf(os, " -v Display version information and exit\n"); return error ? 1 : 0; } -- cgit v1.2.1