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

List:       tuscany-dev
Subject:    Re: Tuscany JavaDocs Refresh
From:       Dan Becker <dan.o.becker () gmail ! com>
Date:       2009-01-29 16:10:59
Message-ID: 4981D513.80409 () gmail ! com
[Download RAW message or body]

ant elder wrote:
> Certainly an improvement over only having the 0.9 level doc, can see why no
> one has done it since then if it takes over 7 hours :)
> 
> One thing is that doesn't include the spec defined API classes, i guess they
> were filtered out as they're org.osoa.sca not org.apache.tuscany.sca.

I will add those. Good find.

> 
>    ...ant
> 
> On Wed, Jan 28, 2009 at 4:38 PM, Dan Becker <dan.o.becker@gmail.com> wrote:
> 
>> I made some JavaDocs for Tuscany 1.4. If you would like to have a look, I
>> placed it on my Apache personal space here [1], and once I get a few
>> comments or change requests, I will check it in.
>>
>> Please let me know if you would like to change the style, add any titles or
>> footers, or remove any packages.
>>
>> Here is the basic method I used to generate the docs:
>> 1) Get a directory list of all src directories under tuscany modules.
>> 2) Grep only for paths that end in src/main/java.
>> 3) Generate javadoc with
>>   javadoc -d html -sourcepath $(SRCDIRS) -subpackages org.apache.tuscany
>>
>> (Note that SRCDIRS contains a list of 133 directories. It took my laptop
>> over 7 hours to generate all the files. Maybe next time I will copy all the
>> src trees to one location to save time. The zip file of the docs is 5.8 MB.)
>>
>> [1] http://people.apache.org/~beckerdo/tuscany/<http://people.apache.org/%7Ebeckerdo/tuscany/>
>>
>>
>> Luciano Resende wrote:
>>
>>> When we last looked at this, there was an issue around grouping the
>>> java docs produced by multiple modules, and we had to do it manually.
>>>
>>> I was thinking about this for 2.x, and one idea would be to use the
>>> same technique we use to produce a "all jar", where we group multiple
>>> modules, and then produce the javadoc from that temporary grouped set
>>> of modules ?
>>>
>>> On Tue, Jan 27, 2009 at 8:26 AM, Dan Becker <dan.o.becker@gmail.com>
>>> wrote:
>>>
>>>> I noticed an older Tuscany Jira requesting an update on the Tuscany
>>>> JavaDocs
>>>> [1]. It appears the last public Tuscany JavaDoc we release is at the 0.9
>>>> level. I intend on resolving the Jira and making a 1.4 level JavaDoc and
>>>> publishing at http://tuscany.apache.org/doc/javadoc/. Any words of
>>>> wisdom or
>>>> other helpful hints before I jump?
>>>>
>>>> [1] http://issues.apache.org/jira/browse/TUSCANY-2485



-- 
Thanks, Dan Becker
[prev in list] [next in list] [prev in thread] [next in thread]