Mailing-List: contact httpcomponents-dev-help@jakarta.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "HttpComponents Project" <httpcomponents-dev@jakarta.apache.org>
Received-SPF: neutral (herse.apache.org: local policy)
Message-ID: <45D36217.1040106@dubioso.net>
Date: Wed, 14 Feb 2007 20:25:11 +0100
From: Roland Weber <http-async@dubioso.net>
User-Agent: Mozilla/5.0 (X11; U; Linux i686; en-US;
 rv:1.8.0.9) Gecko/20070102 SeaMonkey/1.0.7
MIME-Version: 1.0
To: HttpComponents Project <httpcomponents-dev@jakarta.apache.org>
Subject: JavaDocs and RFC
Content-Type: text/plain; charset=ISO-8859-15
Content-Transfer-Encoding: 7bit

Hi Oleg,

there are a few places where our JavaDocs include more or less
verbatim quotes from RFCs, including context free grammars. I
don't think that's a good idea. For one there is the copyright
question. But I've also seen some quotes from obsolete RFCs
in code that probably hasn't changed much since HC 2.0.
If a particular piece of code refers to a specific part of an
RFC, we should give a short description of the purpose and
reference the RFC down to the section, but not copy the text
of the RFC into the JavaDocs. www.rfc.net has nice formatted
versions of RFCs where we can even hyperlink to sections.

What do you think?

cheers,
  Roland


---------------------------------------------------------------------
To unsubscribe, e-mail: httpcomponents-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: httpcomponents-dev-help@jakarta.apache.org