Re: Exclude attribute to javadoc

[Ken Wood]

At 09:43 AM 10/20/00 -0400, [EMAIL PROTECTED] wrote:

Well, there are two ways we can fix this.  Either add a matching task like
functionality to javadoc (which I'm not really willing to do with being so
close to a release) or copy the source tree into a clean directory and then
build the Javadoc.

I agree it's best to wait to next release...

 I'm leaning towards the latter becuase doing the
Javadoc is a farily infrequent event.

False assumption. We have 80 developers working our project.
Enough changes from day to day that we include a javadoc step
in the nightly build. The developer's web page points to the product
docs that are built. Also, we have 3 branches going, so that means
javadoc in each branch each night.

Let's see. 3 branches times 12 source bases  - that's 36 a night,
365 days a year. I would not call that infrequent....

But, your solution will work until the matching task is added.
In fact, it would make javadoc look much cleaner if we could
list package names using something like the fileset or patternset
the way we can with, say, jar or zip command...

So in your case, you may need to do

<copy todir="${doc.src.dir}">
  <fileset dir="../Util/java">
    <include name="**/*.java" />
    <exclude name="**/SCCS" />
  </fileset>
</copy>

<javadoc packagenames="se.lentus.util.*"
         sourcepath="${doc.src.dir}"
         destdir="${javadoc}"
         author="true"
         version="true"
         use="true"
         windowtitle="Test API"
         doctitle="Test"
         bottom="&lt;i>Copyright &#169; 2000 Dummy Corp. All Rights
Reserved.&lt;/i>">
</javadoc>

<delete dir="${doc.src.dir}" />

Not elegant, but it does get us around the problem.  Comments?

Glenn McAllister
Software Developer. IBM Toronto Lab, (416) 448-3805
"An approximate answer to the right question is better than the
right answer to the wrong question." - John W. Tukey

Please respond to [EMAIL PROTECTED]

To:   [EMAIL PROTECTED]
cc:
Subject:  Exclude attribute to javadoc

Hi,

I think I need an exclude attribute to javadoc,

I am trying to run javadoc and it seems like
I need an exclude attribute, since I have a lot of SCCS direcories
laying all around in my source-code, (they originate from my source-code
control system, bitkeeper)

or am I using javadoc in the wrong way?

I am using ant/2000-10-12

and the target looks like

<target name="javadoc" depends="prepare">
  <javadoc packagenames="se.lentus.util.*"
           sourcepath="../Util/java"
           destdir="${javadoc}"
           author="true"
           version="true"
           use="true"
           windowtitle="Test API"
           doctitle="Test"
           bottom="&lt;i>Copyright &#169; 2000 Dummy Corp. All Rights
Reserved.&lt;/i>">
  </javadoc>
</target>

Output is:
javadoc:
  [javadoc] Generating Javadoc
  [javadoc] Javadoc execution
  [javadoc] Loading source files for package se.lentus.util...
  [javadoc] Loading source files for package se.lentus.util.swing...
  [javadoc] Loading source files for package
se.lentus.util.swing.SCCS...
  [javadoc]
/home/users/alu/bk/LENTUS/Util/java/se/lentus/util/swing/SCCS/s.Tree
TableModel.java:1: Invalid character in input.

/Regards,
Peter