Re: Usage of RFC documentation for Javadoc

[Mark Wielaard]

Hi Wolfgang,

On Wed, 2005-11-30 at 20:03 +0100, Wolfgang Baer wrote:
> So the question comes to my mind if we also can use or
> maybe quote from the RFC documents in our javadocs.
> This would make documentation easier and as its the
> specification also correct in every detail.
> 
> For your convenience I attached the full copyright
> statement of the RFC documents.
> 
> Opinions ?

Yes, you can use the text of that RFC for the documentation of the
classes. If you look into our LICENSE file you see that the same is
already done for org/ietf/jgss using RFC 2853.

There are a couple of steps to follow when doing this.

- We need to inform FSF legal (licensing@) that we wish to incorporate
  such text. Can you give me the RFC numbers? Then I inform them and
  include the text from the RFC. (We need to double check since not all
  RFCs come with precisely the same permission text.)

- We need to add a similar note as already done for org/ietf/jgss to the
  LICENSE file. That file should list all legal text so the user has
  one place to review them all.

- Each file that includes documentation from the RFC should have the
  full permission statement as part of the first comment block just
  after the standard boilerplate. See for an example the file
  org/ietf/jgss/Oid.java. This makes sure each file as all notices
  covering the work so people can look it up even in isolation. And that
  way the text is automatically picked up by gjdoc -licensetext so that
  the generated documentation includes all notices automatically.

Cheers,

Mark

signature.asc
Description: This is a digitally signed message part