commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Phil Steitz <phil.ste...@gmail.com>
Subject Re: svn commit: r1586926 - in /commons/proper/dbcp/trunk/src/test/java/org/apache/commons/dbcp2: TestConnectionPool.java TestPStmtPoolingBasicDataSource.java
Date Sun, 13 Apr 2014 22:30:44 GMT
On 4/13/14, 3:21 PM, Niall Pemberton wrote:
> I don't see any value in test Javadocs and IMO they should be removed.
You mean from the website, right?

I think there is a lot of value in adding docs to the tests - like
the ones complained about here - that explain how the tests operate,
what the parms mean, etc.  This is especially true for complicated
setups like we have in some of the [pool], [dbcp] and [math] tests. 
Patches including more / better javadoc and inline comments in the
tests are most appreciated.  I don't care much about the format, but
the content can be valuable. 

Phil
>
> Niall
>
>
> On Sun, Apr 13, 2014 at 10:47 PM, sebb <sebbaz@gmail.com> wrote:
>
>> On 13 April 2014 18:38, Phil Steitz <phil.steitz@gmail.com> wrote:
>>> On 4/13/14, 10:33 AM, sebb wrote:
>>>> Agreed; <name> will cause Java 8 Javadoc to report errors.
>>>>
>>>> If you don't want to use @code, one can always use {name} or [name]
>> instead.
>>>> Just don't use HTML tag delimiters ...
>>> Makes no difference to me, as we don't generate html javadoc for
>>> test code.
>> Actually, the site build does currently include test Javadocs, for example:
>>
>> http://commons.apache.org/proper/commons-dbcp/testapidocs/index.html
>>
>>> Change it however you want.
>> OK
>>
>>> What would be *really*
>>> useful is to help actually resolve the bug that this commit
>>> illustrates - it is a material bug in DBCP 2.
>>>
>>> Phil
>>>> On 13 April 2014 18:21, Gary Gregory <garydgregory@gmail.com> wrote:
>>>>> -1 to using <> instead of {@code}
>>>>>
>>>>> Gary
>>>>>
>>>>> <div>-------- Original message --------</div><div>From:
Bernd <
>> ecki@zusammenkunft.net> </div><div>Date:04/13/2014  10:50  (GMT-05:00)
>> </div><div>To: Commons Developers List <dev@commons.apache.org>
>> </div><div>Subject: Re: svn commit: r1586926 - in
>> /commons/proper/dbcp/trunk/src/test/java/org/apache/commons/dbcp2:
>> TestConnectionPool.java TestPStmtPoolingBasicDataSource.java </div><div>
>>>>> </div>Hello,
>>>>>
>>>>> Am 13.04.2014 08:11 schrieb <psteitz@apache.org>:
>>>>>> Author: psteitz
>>>>>> Date: Sun Apr 13 06:10:44 2014
>>>>>> New Revision: 1586926
>>>>>>
>>>>>> URL: http://svn.apache.org/r1586926
>>>>>> Log:
>>>>>> Added test (commented out) to illustrate DBCP-415.
>>>>>>
>>>>>> Modified:
>>>>>>
>> commons/proper/dbcp/trunk/src/test/java/org/apache/commons/dbcp2/TestConnectionPool.java
>> commons/proper/dbcp/trunk/src/test/java/org/apache/commons/dbcp2/TestPStmtPoolingBasicDataSource.java
>>>>>> Modified:
>> commons/proper/dbcp/trunk/src/test/java/org/apache/commons/dbcp2/TestConnectionPool.java
>>>>>> URL:
>> http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/test/java/org/apache/commons/dbcp2/TestConnectionPool.java?rev=1586926&r1=1586925&r2=1586926&view=diff
>> ==============================================================================
>>>>>> ---
>> commons/proper/dbcp/trunk/src/test/java/org/apache/commons/dbcp2/TestConnectionPool.java
>>>>> (original)
>>>>>> +++
>> commons/proper/dbcp/trunk/src/test/java/org/apache/commons/dbcp2/TestConnectionPool.java
>>>>> Sun Apr 13 06:10:44 2014
>>>>> ...
>>>>>> +    /**
>>>>>> +     * Launches a group of <numThreads> threads, each of which
will
>>>>> attempt to obtain a connection
>>>>>
>>>>> Is using <name> a good idea in Javadoc? I think officially you
would
>> need
>>>>> to use @{code name}.
>>>>>
>>>>> ...
>>>> ---------------------------------------------------------------------
>>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>>> For additional commands, e-mail: dev-help@commons.apache.org
>>>>
>>>>
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>> For additional commands, e-mail: dev-help@commons.apache.org
>>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> For additional commands, e-mail: dev-help@commons.apache.org
>>
>>


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


Mime
View raw message