You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tuscany.apache.org by Dan Becker <da...@gmail.com> on 2009/01/27 17:26:51 UTC
Tuscany JavaDocs Refresh
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
Re: Tuscany JavaDocs Refresh
Posted by Dan Becker <da...@gmail.com>.
Luciano Resende wrote:
>
> Thanks a lot for taking care of this :) It was long due.
> Any chance you have steps or a unix script that we could use to
> generate this during release process ?
I used a progammable editor to generate the docs, but I think it would
be a good idea to create some scripts and add it to our build, perhaps a
Maven docs profile. Let me take this action item.
One limitation we have right now is a Sun JavaDocs bug that causes a
ClassCastException and kills the docs generation. Individual class doc
files are created but some links in the index file are missing. It seems
that classes that use annotations (e.g. Tuscany) can cause this problem.
There are a few workarounds, but the one I tried (putting Annotation
classes on the classpath) did not prevent the issue.
Vote for this Sun bug if you have a free bug vote!
http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6442982
>
> On Thu, Jan 29, 2009 at 8:10 AM, Dan Becker <da...@gmail.com> wrote:
>> 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 <da...@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 <da...@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
Re: Tuscany JavaDocs Refresh
Posted by Luciano Resende <lu...@gmail.com>.
Dan,
Thanks a lot for taking care of this :) It was long due.
Any chance you have steps or a unix script that we could use to
generate this during release process ?
On Thu, Jan 29, 2009 at 8:10 AM, Dan Becker <da...@gmail.com> wrote:
> 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 <da...@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 <da...@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
>
--
Luciano Resende
Apache Tuscany, Apache PhotArk
http://people.apache.org/~lresende
http://lresende.blogspot.com/
Re: Tuscany JavaDocs Refresh
Posted by Dan Becker <da...@gmail.com>.
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 <da...@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 <da...@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
Re: Tuscany JavaDocs Refresh
Posted by ant elder <an...@gmail.com>.
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.
...ant
On Wed, Jan 28, 2009 at 4:38 PM, Dan Becker <da...@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 <da...@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
>
Re: Tuscany JavaDocs Refresh
Posted by Dan Becker <da...@gmail.com>.
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/
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 <da...@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
Re: Tuscany JavaDocs Refresh
Posted by Luciano Resende <lu...@gmail.com>.
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 <da...@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
>
--
Luciano Resende
Apache Tuscany, Apache PhotArk
http://people.apache.org/~lresende
http://lresende.blogspot.com/