Lazy Javadoc question

Roedy Green · May 5, 2009

Every time I run Javadoc it generates some HTML like this:

<HEAD>

<TITLE>
Affirm
</TITLE>

<META NAME="date" CONTENT="2009-05-01">

That's the date Javadoc was run, not the date the content changed.

This triggers huge amounts of nugatory commits to the version control
source repository and masks the real changes. Is there an easy way to
turn this off?

I suppose the other approach not to put generated Javadoc in the
repository. I thought it would be useful to users to track changes to
the public API.

--
Roedy Green Canadian Mind Products
http://mindprod.com

"Species evolve exactly as if they were adapting as best they could to a changing world, and not at all as if they were moving toward a set goal."
~ George Gaylord Simpson

Joshua Cranmer · May 5, 2009

Roedy said:
This triggers huge amounts of nugatory commits to the version control
source repository and masks the real changes. Is there an easy way to
turn this off?

javadoc -notimestamp ?

(Taken from reading help and the source code of Javadoc)

Martin Gregorie · May 5, 2009

This triggers huge amounts of nugatory commits to the version control
source repository and masks the real changes. Is there an easy way to
turn this off?

I suppose the other approach not to put generated Javadoc in the
repository. I thought it would be useful to users to track changes to
the public API.

I wouldn't put generated anything on a repository - it seem to me this
just makes the repository bigger and gains little if anything.

A better approach would almost certainly to have something (package.html?)
to which you can attach the comments you want users to see. You could
and commit legible change descriptions to that and use a script to
extract its version history and turn it into a web page.

Seamus MacRae · May 8, 2009

Martin said:
I wouldn't put generated anything on a repository - it seem to me this
just makes the repository bigger and gains little if anything.

A better approach would almost certainly to have something (package.html?)

Don't we use package-info.java these days?

Martin Gregorie · May 11, 2009

Don't we use package-info.java these days?

You can use either. Depends whether you want annotations or not.

Lazy Javadoc question	1	May 5, 2009
Canonical ordering of javadoc comments	2	May 3, 2009
"final" bug??	8	May 2, 2009
File level asserts.	5	May 6, 2009
pruning a Zip	12	May 9, 2009
final and constructor, a Java Wart	14	May 2, 2009
a class refactoring problem.	3	May 2, 2009
[ANN] httpclient/2.1.5	0	Jun 9, 2009

Lazy Javadoc question

Roedy Green

Joshua Cranmer

Martin Gregorie

Seamus MacRae

Martin Gregorie

Ask a Question

Similar Threads

Members online

Forum statistics

Latest Threads