pr...

Tim Ruppert Wed, 18 Jun 2008 04:41:07 -0700

Personally, I've always just documented the classes themselves very well in the past - and haven't added any of these HTML files and it's been great. My two cents.


Cheers,
Tim
--
Tim Ruppert
HotWax Media
http://www.hotwaxmedia.com


o:801.649.6594
f:801.649.6595


On Jun 18, 2008, at 2:06 AM, Jacopo Cappellato wrote:

Let's wait for the feedback from others then (maybe in the meantime you could revert r668804)... I am curious to know if there are better suggestions/ideas because, as I said before, I don't like too much about the idea of having a bunch of package-info.java classes around. I'm wondering if it was possible for the software architects at Sun to design a cleaner solution for documenting Java packages :)


Jacopo


On Jun 18, 2008, at 8:44 AM, [EMAIL PROTECTED] wrote:

Hi Jacopo,

I'm trying to start to document the java packages of OFBiz (visible in http://api.ofbiz.org) and until now I know that there was only this way to document the packages. I also prefer your new suggestion to document it with a class named package-info.java and I will rename it and include the ASF header license. Before proceed with this way everyone is agree with us or we have to abandon it.

What did you think of it ?

Thanks a lot
Marco

We may also consider this information:

http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#packagecomment

IMO this is slightly better but I still don't like this approach too
much.

Jacopo

On Jun 18, 2008, at 7:55 AM, Jacopo Cappellato wrote:

Also,

we can't add files without the license information in them.

Jacopo


On Jun 18, 2008, at 6:59 AM, Jacopo Cappellato wrote:

Marco,

I understand that this is something that is encouraged by Sun, but

still I am not sure I like it... it sounds like we will have to add

a lot of html files to our src folders.
I'd suggest to pause and think and discuss a bit more about this
before going on.
What do you think?

Jacopo


On Jun 17, 2008, at 11:05 PM, [EMAIL PROTECTED] wrote:


It will appear like this if you insert the package.html on every
single java package.

Il giorno 17/giu/08, alle ore 23:01, [EMAIL PROTECTED] ha scritto:

These files package.html are standard file into the source folder

making working javadocs correctly the documents about packages.

Take a look at this link: 
http://java.sun.com/j2se/javadoc/writingdoccomments/#packagecomments

This is the first steps to see on the first page of http://api.ofbiz.org
the descriptions of java packages.

Thanks
Marco


Il giorno 17/giu/08, alle ore 21:48, Adrian Crum ha scritto:

Why are javadocs being committed to the trunk?

-Adrian

[EMAIL PROTECTED] wrote:

Author: mrisaliti
Date: Tue Jun 17 12:25:17 2008
New Revision: 668804
URL: http://svn.apache.org/viewvc?rev=668804&view=rev
Log:
First javadoc comments on product packages.
Added:

ofbiz/trunk/applications/product/src/org/ofbiz/product/ catalog/

package.html   (with props)

ofbiz/trunk/applications/product/src/org/ofbiz/product/ category/

package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/product/config/
package.html   (with props)

ofbiz/trunk/applications/product/src/org/ofbiz/product/ feature/

package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/product/
inventory/package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/product/price/
package.html   (with props)

ofbiz/trunk/applications/product/src/org/ofbiz/product/ product/

package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/product/promo/
package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/product/
spreadsheetimport/package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/product/store/
package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/product/
subscription/package.html   (with props)

ofbiz/trunk/applications/product/src/org/ofbiz/product/ supplier/

package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/product/test/
package.html   (with props)

ofbiz/trunk/applications/product/src/org/ofbiz/shipment/ packing/

package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/shipment/
picklist/package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/shipment/
shipment/package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/shipment/
thirdparty/dhl/package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/shipment/
thirdparty/fedex/package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/shipment/
thirdparty/ups/package.html   (with props)
ofbiz/trunk/applications/product/src/org/ofbiz/shipment/
thirdparty/usps/package.html   (with props)
Added: ofbiz/trunk/applications/product/src/org/ofbiz/product/
catalog/package.html
URL: 
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/catalog/package.html?rev=668804&view=auto
=
=
=
=
=
=
=
=
=
=
=
=
=

= = = ==============================================================

--- ofbiz/trunk/applications/product/src/org/ofbiz/product/
catalog/package.html (added)
+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/
catalog/package.html Tue Jun 17 12:25:17 2008
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<title>org.ofbiz.product.catalog</title>
+</head>
+<body bgcolor="white">
+Worker classes for catalogs.
+</body>
+</html>
\ No newline at end of file
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/catalog/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/catalog/package.html
------------------------------------------------------------------------------
svn:keywords = "Date Rev Author URL Id"
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/catalog/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/trunk/applications/product/src/org/ofbiz/product/
category/package.html
URL: 
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/category/package.html?rev=668804&view=auto
=
=
=
=
=
=
=
=
=
=
=
=
=

= = = ==============================================================

--- ofbiz/trunk/applications/product/src/org/ofbiz/product/
category/package.html (added)
+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/
category/package.html Tue Jun 17 12:25:17 2008
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<title>org.ofbiz.product.category</title>
+</head>
+<body bgcolor="white">
+Worker and utilities classes for categories.
+</body>
+</html>
\ No newline at end of file
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/category/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/category/package.html
------------------------------------------------------------------------------
svn:keywords = "Date Rev Author URL Id"
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/category/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/trunk/applications/product/src/org/ofbiz/product/
config/package.html
URL: 
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/config/package.html?rev=668804&view=auto
=
=
=
=
=
=
=
=
=
=
=
=
=

= = = ==============================================================

--- ofbiz/trunk/applications/product/src/org/ofbiz/product/
config/package.html (added)
+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/
config/package.html Tue Jun 17 12:25:17 2008
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<title>org.ofbiz.product.config</title>
+</head>
+<body bgcolor="white">
+Worker and wrapper classes for config products.
+</body>
+</html>
\ No newline at end of file
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/config/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/config/package.html
------------------------------------------------------------------------------
svn:keywords = "Date Rev Author URL Id"
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/config/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/trunk/applications/product/src/org/ofbiz/product/
feature/package.html
URL: 
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/feature/package.html?rev=668804&view=auto
=
=
=
=
=
=
=
=
=
=
=
=
=

= = = ==============================================================

--- ofbiz/trunk/applications/product/src/org/ofbiz/product/
feature/package.html (added)
+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/
feature/package.html Tue Jun 17 12:25:17 2008
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<title>org.ofbiz.product.feature</title>
+</head>
+<body bgcolor="white">
+Utilities classes for products features.
+</body>
+</html>
\ No newline at end of file
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/feature/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/feature/package.html
------------------------------------------------------------------------------
svn:keywords = "Date Rev Author URL Id"
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/feature/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/trunk/applications/product/src/org/ofbiz/product/
inventory/package.html
URL: 
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/inventory/package.html?rev=668804&view=auto
=
=
=
=
=
=
=
=
=
=
=
=
=

= = = ==============================================================

--- ofbiz/trunk/applications/product/src/org/ofbiz/product/
inventory/package.html (added)
+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/
inventory/package.html Tue Jun 17 12:25:17 2008
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<title>org.ofbiz.product.inventory</title>
+</head>
+<body bgcolor="white">
+Worker and utilities classes for inventory.
+</body>
+</html>
\ No newline at end of file
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/inventory/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/inventory/package.html
------------------------------------------------------------------------------
svn:keywords = "Date Rev Author URL Id"
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/inventory/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/trunk/applications/product/src/org/ofbiz/product/
price/package.html
URL: 
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/price/package.html?rev=668804&view=auto
=
=
=
=
=
=
=
=
=
=
=
=
=

= = = ==============================================================

--- ofbiz/trunk/applications/product/src/org/ofbiz/product/
price/package.html (added)
+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/
price/package.html Tue Jun 17 12:25:17 2008
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<title>org.ofbiz.product.price</title>
+</head>
+<body bgcolor="white">
+Worker and utilities classes for product prices.
+</body>
+</html>
\ No newline at end of file
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/price/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/price/package.html
------------------------------------------------------------------------------
svn:keywords = "Date Rev Author URL Id"
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/price/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/trunk/applications/product/src/org/ofbiz/product/
product/package.html
URL: 
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/product/package.html?rev=668804&view=auto
=
=
=
=
=
=
=
=
=
=
=
=
=

= = = ==============================================================

--- ofbiz/trunk/applications/product/src/org/ofbiz/product/
product/package.html (added)
+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/
product/package.html Tue Jun 17 12:25:17 2008
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<title>org.ofbiz.product.product</title>
+</head>
+<body bgcolor="white">
+Searching and workers/utilities classes for products.
+</body>
+</html>
\ No newline at end of file
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/product/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/product/package.html
------------------------------------------------------------------------------
svn:keywords = "Date Rev Author URL Id"
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/product/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/trunk/applications/product/src/org/ofbiz/product/
promo/package.html
URL: 
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/promo/package.html?rev=668804&view=auto
=
=
=
=
=
=
=
=
=
=
=
=
=

= = = ==============================================================

--- ofbiz/trunk/applications/product/src/org/ofbiz/product/
promo/package.html (added)
+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/
promo/package.html Tue Jun 17 12:25:17 2008
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<title>org.ofbiz.product.promo</title>
+</head>
+<body bgcolor="white">
+Utilities classes for products promotions.
+</body>
+</html>
\ No newline at end of file
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/promo/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/promo/package.html
------------------------------------------------------------------------------
svn:keywords = "Date Rev Author URL Id"
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/promo/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/trunk/applications/product/src/org/ofbiz/product/
spreadsheetimport/package.html
URL: 
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/spreadsheetimport/package.html?rev=668804&view=auto
=
=
=
=
=
=
=
=
=
=
=
=
=

= = = ==============================================================

--- ofbiz/trunk/applications/product/src/org/ofbiz/product/
spreadsheetimport/package.html (added)
+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/
spreadsheetimport/package.html Tue Jun 17 12:25:17 2008
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<title>org.ofbiz.product.spreadsheetimport</title>
+</head>
+<body bgcolor="white">

+Helper classes for import products into OFBiz via spreadsheet.

+</body>
+</html>
\ No newline at end of file
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/spreadsheetimport/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/spreadsheetimport/package.html
------------------------------------------------------------------------------
svn:keywords = "Date Rev Author URL Id"
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/spreadsheetimport/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/trunk/applications/product/src/org/ofbiz/product/
store/package.html
URL: 
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/store/package.html?rev=668804&view=auto
=
=
=
=
=
=
=
=
=
=
=
=
=

= = = ==============================================================

--- ofbiz/trunk/applications/product/src/org/ofbiz/product/
store/package.html (added)
+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/
store/package.html Tue Jun 17 12:25:17 2008
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<title>org.ofbiz.product.store</title>
+</head>
+<body bgcolor="white">
+Worker and wrapper classes for products stores.
+</body>
+</html>
\ No newline at end of file
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/store/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/store/package.html
------------------------------------------------------------------------------
svn:keywords = "Date Rev Author URL Id"
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/store/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/trunk/applications/product/src/org/ofbiz/product/
subscription/package.html
URL: 
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/subscription/package.html?rev=668804&view=auto
=
=
=
=
=
=
=
=
=
=
=
=
=

= = = ==============================================================

--- ofbiz/trunk/applications/product/src/org/ofbiz/product/
subscription/package.html (added)
+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/
subscription/package.html Tue Jun 17 12:25:17 2008
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<title>org.ofbiz.product.subscription</title>
+</head>
+<body bgcolor="white">
+Utilities classes for products subscriptions.
+</body>
+</html>
\ No newline at end of file
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/subscription/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/subscription/package.html
------------------------------------------------------------------------------
svn:keywords = "Date Rev Author URL Id"
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/subscription/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/trunk/applications/product/src/org/ofbiz/product/
supplier/package.html
URL: 
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/supplier/package.html?rev=668804&view=auto
=
=
=
=
=
=
=
=
=
=
=
=
=

= = = ==============================================================

--- ofbiz/trunk/applications/product/src/org/ofbiz/product/
supplier/package.html (added)
+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/
supplier/package.html Tue Jun 17 12:25:17 2008
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<title>org.ofbiz.product.supplier</title>
+</head>
+<body bgcolor="white">
+Utilities classes for suppliers of products.
+</body>
+</html>
\ No newline at end of file
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/supplier/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/supplier/package.html
------------------------------------------------------------------------------
svn:keywords = "Date Rev Author URL Id"
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/supplier/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/trunk/applications/product/src/org/ofbiz/product/
test/package.html
URL: 
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/test/package.html?rev=668804&view=auto
=
=
=
=
=
=
=
=
=
=
=
=
=

= = = ============================================================== --- ofbiz/trunk/applications/product/src/org/ofbiz/product/ test/

package.html (added)

+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/ test/

package.html Tue Jun 17 12:25:17 2008
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<title>org.ofbiz.product.test</title>
+</head>
+<body bgcolor="white">
+Junit test classes for products.
+</body>
+</html>
\ No newline at end of file
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/test/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/test/package.html
------------------------------------------------------------------------------
svn:keywords = "Date Rev Author URL Id"
Propchange: ofbiz/trunk/applications/product/src/org/ofbiz/
product/test/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html