[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: [PROPOSAL] Change of convention for multiline string literals

From: Peter Samuelson <peter_at_p12n.org>
Date: 2007-04-22 08:26:43 CEST

[Jonathan Gilbert]
> +/**
> + * A shorter version of APR_EOL_STR; holds the native linefeed for the
> + * current platform. E.g., on UNIX systems, this will be "\n", while on
> + * Windows, it will be "\r\n". This is defined privately because the
> + * macro lacks a namespacing prefix. Used to terminate lines in large
> + * multi-line string literals.
> + */
> +#define NL APR_EOL_STR

IMHO there is no need to use /** here; that's for extracting API
documentation from source files, and NL is not going to become part of
any API.

Indeed, I'm not sure I would document it at all: if anyone doesn't know
what APR_EOL_STR is, they can look it up easily enough. And, speaking
only for myself, the first time I saw APR_EOL_STR in use it was pretty
obvious what it was for anyway.

> + "This directory holds run-time configuration information for
> Subversion" NL
> + "clients. The configuration files all share the same syntax, but you"
> NL
> + "should examine a particular file to learn what configuration"
> NL

And you'll want to tell your email client not to wrap lines when you
paste patches....

Received on Sun Apr 22 08:26:53 2007

This is an archived mail posted to the Subversion Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.