DO NOT REPLY [Bug 32780] New: - Limited documentation for HttpClient constructors

[bu...@apache.org]

DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=32780>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=32780

           Summary: Limited documentation for HttpClient constructors
           Product: HttpClient
           Version: 3.0 Beta 1
          Platform: PC
        OS/Version: Linux
            Status: NEW
          Severity: normal
          Priority: P2
         Component: Commons HttpClient
        AssignedTo: httpclient-dev@jakarta.apache.org
        ReportedBy: ernst.dehaan@nl.wanadoo.com


The (public) Javadoc documentation for the HttpClient constructors is quite
limited (in 3.0-beta1). There is, for example, no documentation on whether
parameters can be null and if not, what the behavior is.

Also, there are multiple links to Javadoc where one link would suffice. For
example, the HttpClient(HttpClientParams) constructor has the following
documentation in the source code:

    /**
     * Creates an instance of HttpClient using the given
     * {@link HttpClientParams parameter set}.
     *
     * @param params The {@link HttpClientParams parameters} to use.
     *
     * @see HttpClientParams
     *
     * @since 3.0
     */

Knowing that the Javadoc tool will generate a link to the HttpClientParams for
the parameter 'params' as well, I count 3 links to that class. To me it would
seem that 2 should be enough, so I propose removing the @see tag.

I will attach a patch that will increase the amount of documentation and remove
@see tags that would duplicate the links to this class.

-- 
Configure bugmail: http://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

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