[prev in list] [next in list] [prev in thread] [next in thread] 

List:       rxtx
Subject:    Re: [Rxtx] Javadoc for Rxtx
From:       Fabio Frumento <f.frumento () ngi ! it>
Date:       2006-02-17 21:32:40
Message-ID: 43F640F8.3020900 () ngi ! it
[Download RAW message or body]

Hi Trent,

ok i'll write with my words all the doc i'm writing, so it can be a Rxtx 
property, hope this is enough. I don't want any problem too. I'll submit 
to you for final approval before sending to the mailing list if you wish.

well... about the cleaning... they are just some markup of the source 
code, i'll post one patch at time for any file with javadoc and the 
"cleanup" but don't wait for big patches the clean up is truly "a bit"

Regards

Fabio


Trent Jarvi wrote:
> On Fri, 17 Feb 2006, Fabio Frumento wrote:
> 
>> Hi Trent,
>>
>> I'm writing some javadoc for Rxtx source while reviewing the code (I 
>> had a long stop since our last e-mails), here are some conventions i'm 
>> using:
>>
>> 1) Reuse of the Sun Documentation as possible (hope this is not a 
>> problem)
>>
>> 2) renaming method's arguments to names used in the sun implementation 
>> (just to standardize variables names...)
>>
>> Also i've cleaned the java code a bit, just formatting issues, removed 
>> unused variables or methods and "if - else" with  redundant brackets
>>
>> Are you interested in a patch ? if yes, can  i send it through the 
>> mailing list ?
>>
>> Regards
>>
>> Fabio Frumento
> 
> 
> Hi Fabio
> 
> With respect to reuse of Sun's Documentation, I don't think thats 
> proper. That work is copyrighted by Sun Microsystems so unless they give 
> us permission, they retain the rights.  We need to respect their 
> licensing just as we hope others respect our licensing.  The work you 
> did yourself with respect to documentation can go in.  It's always 
> better to be safe with copyrights.  It probably qualifies as legal 
> sampling or such but I'd rather not look for trouble with copy/paste 
> derivatives.
> 
> Certainly being consistant with variable names should be OK.
> 
> The problem with "I cleaned up the source" patches is they tend to 
> change many things rather than be small patches that we can all follow.  
> So I'd be interested in them but they need to be broken into patches and 
> posted here as individual concepts.  Then everyone can accept or 
> complain about the changes on a per patch basis.
> 
> As one big patch, you will find that few can give it a good review which 
> should be a goal for all changes.
> 
> -- 
> Trent Jarvi
> tjarvi@qbang.org
> _______________________________________________
> Rxtx mailing list
> Rxtx@qbang.org
> http://mailman.qbang.org/mailman/listinfo/rxtx
_______________________________________________
Rxtx mailing list
Rxtx@qbang.org
http://mailman.qbang.org/mailman/listinfo/rxtx
[prev in list] [next in list] [prev in thread] [next in thread]