Re: javadoc
> How do I generate javadoc for api20? How about maven javadoc -- Andy
Re: javadoc
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 [EMAIL PROTECTED] Engineering GmbH mailto:[EMAIL PROTECTED] http://www.tech.spree.de/ Tel.:++49/30/235 520-33 Buelowstr. 66 Fax.:++49/30/2175 2012D-10783 Berlin
Re: javadoc
Hi Michelle,There is a builtin maven goal "javadoc". Change dir to api20 and maven javadoc.I hadn't known this before you asked...CraigOn Sep 7, 2005, at 10:22 AM, Michelle Caisse wrote:Hi,How do I generate javadoc for api20?-- Michelle Craig Russell Architect, Sun Java Enterprise System http://java.sun.com/products/jdo 408 276-5638 mailto:[EMAIL PROTECTED] P.S. A good JDO? O, Gasp! smime.p7s Description: S/MIME cryptographic signature
Re: javadoc
Thanks, everyone. Should we add to the build goal in api20 and api11? -- 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
Re: javadoc
Hi Michelle, Thanks, everyone. Should we add 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[EMAIL PROTECTED] Engineering GmbH mailto:[EMAIL PROTECTED]http://www.tech.spree.de/ Tel.:++49/30/235 520-33 Buelowstr. 66 Fax.:++49/30/2175 2012 D-10783 Berlin
Re: javadoc
Good idea. Javadoc for api packages is an important part of the functionality.CraigOn Sep 7, 2005, at 11:30 AM, Michael Bouschen wrote:Hi Michelle, Thanks, everyone. Should we add to the build goal in api20 and api11? Yes, I think this makes sense for the api11 and api20.Regards Michael -- MichelleMichael Bouschen wrote: Hi Michelle,please try maven javadoc. It generates the javadoc undertarget/docs/apidocs and some report files under target/javadoc.Regards Michael Hi,How do I generate javadoc for api20?-- Michelle -- Michael Bouschen [EMAIL PROTECTED] Engineering GmbHmailto:[EMAIL PROTECTED] 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:[EMAIL PROTECTED] P.S. A good JDO? O, Gasp! smime.p7s Description: S/MIME cryptographic signature
Re: javadoc
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 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[EMAIL PROTECTED] Engineering GmbH mailto:[EMAIL PROTECTED]http://www.tech.spree.de/ Tel.:++49/30/235 520-33Buelowstr. 66 Fax.:++49/30/2175 2012D-10783 Berlin Craig Russell Architect, Sun Java Enterprise System http://java.sun.com/products/jdo 408 276-5638 mailto:[EMAIL PROTECTED] P.S. A good JDO? O, Gasp! -- Karan Singh
Re: javadoc
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,CraigOn 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.CraigOn Sep 7, 2005, at 11:30 AM, Michael Bouschen wrote: Hi Michelle, Thanks, everyone. Should we add to the build goal in api20 and api11? Yes, I think this makes sense for the api11 and api20.Regards Michael -- MichelleMichael Bouschen wrote: Hi Michelle,please try maven javadoc. It generates the javadoc undertarget/docs/apidocs and some report files under target/javadoc.Regards Michael Hi,How do I generate javadoc for api20?-- Michelle -- Michael Bouschen [EMAIL PROTECTED] Engineering GmbHmailto:[EMAIL PROTECTED] http://www.tech.spree.de/Tel.:++49/30/235 520-33 Buelowstr. 66 Fax.:++49/30/2175 2012 D-10783 Berlin Craig RussellArchitect, Sun Java Enterprise System http://java.sun.com/products/jdo408 276-5638 mailto:[EMAIL PROTECTED]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:[EMAIL PROTECTED] P.S. A good JDO? O, Gasp! smime.p7s Description: S/MIME cryptographic signature
Re: javadoc
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 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[EMAIL PROTECTED] Engineering GmbH mailto:[EMAIL PROTECTED]http://www.tech.spree.de/ Tel.:++49/30/235 520-33Buelowstr. 66 Fax.:++49/30/2175 2012D-10783 Berlin Craig Russell Architect, Sun Java Enterprise System http://java.sun.com/products/jdo 408 276-5638 mailto:[EMAIL PROTECTED] 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:[EMAIL PROTECTED] P.S. A good JDO? O, Gasp! -- Karan Singh
Re: javadoc
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?CraigOn 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,CraigOn 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.CraigOn Sep 7, 2005, at 11:30 AM, Michael Bouschen wrote: Hi Michelle, Thanks, everyone. Should we add to the build goal in api20 and api11? Yes, I think this makes sense for the api11 and api20.Regards Michael -- MichelleMichael Bouschen wrote: Hi Michelle,please try maven javadoc. It generates the javadoc undertarget/docs/apidocs and some report files under target/javadoc.Regards Michael Hi,How do I generate javadoc for api20?-- Michelle -- Michael Bouschen [EMAIL PROTECTED] Engineering GmbHmailto:[EMAIL PROTECTED] http://www.tech.spree.de/Tel.:++49/30/235 520-33 Buelowstr. 66 Fax.:++49/30/2175 2012 D-10783 Berlin Craig RussellArchitect, Sun Java Enterprise System http://java.sun.com/products/jdo408 276-5638 mailto:[EMAIL PROTECTED]P.S. A good JDO? O, Gasp! -- Karan Singh Craig RussellArchitect, Sun Java Enterprise System http://java.sun.com/products/jdo408 276-5638 mailto:[EMAIL PROTECTED]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:[EMAIL PROTECTED] P.S. A good JDO? O, Gasp! smime.p7s Description: S/MIME cryptographic signature
Re: javadoc
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 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[EMAIL PROTECTED] Engineering GmbH mailto:[EMAIL PROTECTED]http://www.tech.spree.de/ Tel.:++49/30/235 520-33Buelowstr. 66 Fax.:++49/30/2175 2012D-10783 Berlin Craig Russell Architect, Sun Java Enterprise System http://java.sun.com/products/jdo 408 276-5638 mailto:[EMAIL PROTECTED] 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:[EMAIL PROTECTED] 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:[EMAIL PROTECTED] P.S. A good JDO? O, Gasp! -- Karan Singh
Re: Javadoc warning with api20 interface FetchPlan
Hi Michael, Please go ahead and check in the fix. Craig On Mar 16, 2006, at 12:12 PM, Michael Bouschen wrote: Hi, when building the api20 project using JDK1.4 I get a javadoc warning from the FetchPlan interface. You find the warning in the attached text file. I propose to change the javadoc comment to avoid the warning. You my proposed change in the patch file. Regards Michael -- Michael Bouschen[EMAIL PROTECTED] Engineering GmbH mailto:[EMAIL PROTECTED]http://www.tech.spree.de/ Tel.:++49/30/235 520-33 Buelowstr. 66 Fax.:++49/30/2175 2012 D-10783 Berlin maven-javadoc-plugin:report: [mkdir] Created dir: D:\jdo\workspaces\jdo\trunk\api20\target \javadoc\src [javadoc] Generating Javadoc [javadoc] Javadoc execution [javadoc] Loading source files for package javax.jdo... [javadoc] Loading source files for package javax.jdo.datastore... [javadoc] Loading source files for package javax.jdo.identity... [javadoc] Loading source files for package javax.jdo.listener... [javadoc] Loading source files for package javax.jdo.spi... [javadoc] Constructing Javadoc information... [javadoc] Standard Doclet version 1.4.2_10 [javadoc] Generating D:\jdo\workspaces\jdo\trunk\api20\target \docs\apidocs\constant-values.html... [javadoc] Copying file D:\users\michael\.maven\cache\maven- javadoc-plugin-1.7\plugin-resources\stylesheet.css to file D:\jdo \workspaces\jdo\trunk\api20\target\docs\apidocs\stylesheet.css... [javadoc] Building tree for all the packages and classes... [javadoc] D:\jdo\workspaces\jdo\trunk\api20\src\java\javax\jdo \FetchPlan.java:152: warning - The first sentence is interpreted to be: [javadoc] Generating D:\jdo\workspaces\jdo\trunk\api20\target \docs\apidocs\javax\jdo\class-use\FetchPlan.html... [javadoc] "Set the maximum fetch depth when fetching." [javadoc] This sentence is different from what will be interpreted as the first sentence in the [javadoc] next major release (when that interpretation will be internationalized), which is: [javadoc] "Set the maximum fetch depth when fetching. [javadoc] 0 has no meaning and will throw a JDOUserException" [javadoc] To avoid this note, change the doc comment to make this a proper first sentence, then [javadoc] use -breakiterator from that point forward, which will output this new sentence. [javadoc] Building index for all the packages and classes... [javadoc] D:\jdo\workspaces\jdo\trunk\api20\src\java\javax\jdo \FetchPlan.java:152: warning - The first sentence is interpreted to be: [javadoc] Generating D:\jdo\workspaces\jdo\trunk\api20\target \docs\apidocs\index-all.html... [javadoc] "Set the maximum fetch depth when fetching." [javadoc] This sentence is different from what would be generated using -breakiterator: [javadoc] "Set the maximum fetch depth when fetching. [javadoc] 0 has no meaning and will throw a JDOUserException" [javadoc] Building index for all classes... [javadoc] D:\jdo\workspaces\jdo\trunk\api20\src\java\javax\jdo \FetchPlan.java:152: warning - The first sentence is interpreted to be: [javadoc] Generating D:\jdo\workspaces\jdo\trunk\api20\target \docs\apidocs\javax\jdo\FetchPlan.html... [javadoc] "Set the maximum fetch depth when fetching." [javadoc] This sentence is different from what would be generated using -breakiterator: [javadoc] "Set the maximum fetch depth when fetching. [javadoc] 0 has no meaning and will throw a JDOUserException" [javadoc] Generating D:\jdo\workspaces\jdo\trunk\api20\target \docs\apidocs\help-doc.html... [javadoc] 3 warnings [delete] Deleting directory D:\jdo\workspaces\jdo\trunk\api20 \target\javadoc\src Index: src/java/javax/jdo/FetchPlan.java === --- src/java/javax/jdo/FetchPlan.java (revision 386408) +++ src/java/javax/jdo/FetchPlan.java (working copy) @@ -141,8 +141,8 @@ /** * Set the maximum fetch depth when fetching. - * 0 has no meaning and will throw a JDOUserException. - * -1 means that no limit is placed on fetching. + * A value of 0 has no meaning and will throw a JDOUserException. + * A value of -1 means that no limit is placed on fetching. * A positive integer will result in that number of references from the * initial object to be fetched. * @param fetchDepth the depth Craig Russell Architect, Sun Java Enterprise System http://java.sun.com/products/jdo 408 276-5638 mailto:[EMAIL PROTECTED] P.S. A good JDO? O, Gasp! smime.p7s Description: S/MIME cryptographic signature
