db-jdo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From karan malhi <karan.ma...@gmail.com>
Subject Re: javadoc
Date Wed, 07 Sep 2005 23:20:01 GMT
Yes,

I would love to do that. I am just going to outline issues which i 
faced/am facing as a newcomer to the project . If all of you can fill in 
the details, that would be a great great help.

Thanks. :)

Craig Russell wrote:

> Hi Karan,
>
> The concept of a HowTo is really good. If you write an outline we can 
> fill it out and publish it. I'd think this belongs on the site. What 
> do you think?
>
> Craig
>
> On Sep 7, 2005, at 3:47 PM, karan malhi wrote:
>
>> Hi Craig,
>>
>> The first thing i would like to suggest is a quick How-To. How to run 
>> tests, how and when to run tests offline, what are the various 
>> configuration files and their significance, when do you need to 
>> invoke installSchema, how to see generated sql and logging 
>> information, how to integrate an IDE using mevenide, what is the 
>> current focus of the main committers of the project. The goal of this 
>> document is that people should be able to read this 
>> How-To/First-Steps document and immediately get a feel of the project 
>> and not search for basic information about maven or about the project 
>> itself. Even though i myself am not clear on so many things in this 
>> project, i guess have such a document and an active contribution to 
>> its development will definitely attract more developers.
>>
>> Craig Russell wrote:
>>
>>
>>> Hi Karan,
>>>
>>> I think it makes sense to migrate some of the wiki information to 
>>> the jdo site. We start with discussions on the wiki but once the 
>>> information has stabilized, it should be moved to the site.
>>>
>>> We looked at having Maven generate the site but it only does part of 
>>> the job and there is a bunch of stuff that isn't very interesting.
>>>
>>> I know we need to improve the site; it would be great if you as a 
>>> newcomer to the project could suggest specific things to do.
>>>
>>> Thanks,
>>>
>>> Craig
>>>
>>> On Sep 7, 2005, at 1:02 PM, karan malhi wrote:
>>>
>>>
>>>> What about the documentation on the incubator.apache.org/jdo 
>>>> website. Maven could generate a lot of stuff for that too. Could we 
>>>> think about moving some stuff from the wiki to the documentation on 
>>>> the incubator site. The reason is that there is a lot of good 
>>>> information on the wiki, but some of the links are orphaned and 
>>>> many other pages are really hard to find (it was very difficult for 
>>>> me in the beginning).
>>>>
>>>> Craig Russell wrote:
>>>>
>>>>
>>>>
>>>>> Good idea. Javadoc for api packages is an important part of the 
>>>>> functionality.
>>>>>
>>>>> Craig
>>>>>
>>>>> On Sep 7, 2005, at 11:30 AM, Michael Bouschen wrote:
>>>>>
>>>>>
>>>>>
>>>>>> Hi Michelle,
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>> Thanks, everyone.  Should we add <attainGoal javadoc> to
the 
>>>>>>> build goal in api20 and api11?
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>
>>>>>> Yes, I think this makes sense for the api11 and api20.
>>>>>>
>>>>>> Regards Michael
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>>
>>>>>>> -- Michelle
>>>>>>>
>>>>>>> Michael Bouschen wrote:
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>> Hi Michelle,
>>>>>>>>
>>>>>>>> please try maven javadoc. It generates the javadoc under
>>>>>>>> target/docs/apidocs and some report files under target/javadoc.
>>>>>>>>
>>>>>>>> Regards Michael
>>>>>>>>
>>>>>>>>  
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>> Hi,
>>>>>>>>>
>>>>>>>>> How do I generate javadoc for api20?
>>>>>>>>>
>>>>>>>>> -- Michelle
>>>>>>>>>
>>>>>>>>>   
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>  
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>
>>>>>>
>>>>>> -- 
>>>>>> Michael Bouschen        Tech@Spree Engineering GmbH
>>>>>> mailto:mbo.tech@spree.de    http://www.tech.spree.de/
>>>>>> Tel.:++49/30/235 520-33        Buelowstr. 66            
>>>>>> Fax.:++49/30/2175 2012        D-10783 Berlin            
>>>>>>
>>>>>>
>>>>>
>>>>> Craig Russell
>>>>>
>>>>> Architect, Sun Java Enterprise System http://java.sun.com/products/jdo
>>>>>
>>>>> 408 276-5638 mailto:Craig.Russell@sun.com
>>>>>
>>>>> P.S. A good JDO? O, Gasp!
>>>>>
>>>>>
>>>>>
>>>>>
>>>>
>>>> -- 
>>>> Karan Singh
>>>>
>>>>
>>>>
>>>
>>> Craig Russell
>>>
>>> Architect, Sun Java Enterprise System http://java.sun.com/products/jdo
>>>
>>> 408 276-5638 mailto:Craig.Russell@sun.com
>>>
>>> P.S. A good JDO? O, Gasp!
>>>
>>>
>>>
>>
>> -- 
>> Karan Singh
>>
>>
>
> Craig Russell
>
> Architect, Sun Java Enterprise System http://java.sun.com/products/jdo
>
> 408 276-5638 mailto:Craig.Russell@sun.com
>
> P.S. A good JDO? O, Gasp!
>
>

-- 
Karan Singh


Mime
View raw message