You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hc.apache.org by Joerg Bullmann <jb...@heilancoo.net> on 2007/10/26 11:43:45 UTC

JavaDoc

Another quick one:

It is my impression that the JavaDocs in HTTPcore and friends are next to nil in terms of actual description of the classes and methods etc. If I ventured to fill in some info, would sending someone a patch of this be the right way to contribute?

Cheers,
Joerg


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


Re: JavaDoc

Posted by Oleg Kalnichevski <ol...@apache.org>.
On Fri, 2007-10-26 at 11:57 +0200, Ortwin Glück wrote:
> Jörg,
> 
> We happily accept API Doc patches. Please open a Ticket in Jira and
> attach the patches. Oleg prefers to hack away and document later when
> the project leaves alpha stadium.
> 
> Odi
> 

Joerg,

There was no point in writing extensive documentation of API that was
still undergoing lots of changes. Now that we are gradually getting
close to the API freeze, some more attention to the javadocs would be
awesome. There is even already a JIRA ticket for that. 

https://issues.apache.org/jira/browse/HTTPCORE-2

Oleg

> Joerg Bullmann wrote:
> > Another quick one:
> > 
> > It is my impression that the JavaDocs in HTTPcore and friends are next to nil in terms of actual description of the classes and methods etc. If I ventured to fill in some info, would sending someone a patch of this be the right way to contribute?
> > 
> > Cheers,
> > Joerg
> > 
> > 
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: httpcomponents-dev-unsubscribe@jakarta.apache.org
> > For additional commands, e-mail: httpcomponents-dev-help@jakarta.apache.org
> > 
> 


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


Re: JavaDoc

Posted by Ortwin Glück <od...@odi.ch>.
Jörg,

We happily accept API Doc patches. Please open a Ticket in Jira and
attach the patches. Oleg prefers to hack away and document later when
the project leaves alpha stadium.

Odi

Joerg Bullmann wrote:
> Another quick one:
> 
> It is my impression that the JavaDocs in HTTPcore and friends are next to nil in terms of actual description of the classes and methods etc. If I ventured to fill in some info, would sending someone a patch of this be the right way to contribute?
> 
> Cheers,
> Joerg
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: httpcomponents-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: httpcomponents-dev-help@jakarta.apache.org
> 

-- 
[web]  http://www.odi.ch/
[blog] http://www.odi.ch/weblog/
[pgp]  key 0x81CF3416
       finger print F2B1 B21F F056 D53E 5D79 A5AF 02BE 70F5 81CF 3416

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