What options are used to build the Javadoc for Selenium?

[Mike]

I am asking this because the Javadoc is not included in the ZIP file
with the sources for the Java client.

I have created a project in Netbeans so I can build it from source,
which was very easy to do by the way. But when I go to create the
Javadoc I get 100 errors, most of which seem to be due to @link and
@see tags. I figure this might be a javadoc command option that is
not turned on by default, so I am wondering if anyone can provide the
switch settings for it that has built the javadoc before.

Mike

[Tarun Bhadauria]

adding dev group.
Original discussion is available at - https://groups.google.com/forum/#!topic/selenium-users/X5pDL2XxPCA

#############################

##############################

Mike

[Simon Stewart]

We generate the javadocs by checking out the source code and running
"./go javadocs"

Simon

> --
> You received this message because you are subscribed to the Google Groups "Selenium Users" group.
> To post to this group, send email to seleniu...@googlegroups.com.
> To unsubscribe from this group, send email to selenium-user...@googlegroups.com.
> For more options, visit this group at http://groups.google.com/group/selenium-users?hl=en.
>
>

[Mike]

Okay, that helped me find it. I am building using Netbeans 7.0 on
Windows (I would prefer Linux or Solaris, but it is what I have) and I
have grabbed a snapshot of the current version in svn. I have
corrected a lot of Javadoc mistakes that I found (wrong parameters or
@return with no description) for both the server and client trees.
But I get a lot of errors with the @see and @link tags, so I wanted to
see if there was some option that could fix my copy.

I have both building okay, with the exception of a few modules in the
test path of the tree. I just wanted to get an accurate Javadoc
representation of the sources as they are now, since what is online
may not represent what I use later as changes are made.

I have not contributed to Selenium yet, except for filing some bugs.
Let me know if you would like these Javadoc corrections and what the
best way is to get them to you.

Thanks for the pointer to the go script.

Mike

[Simon Stewart]

I know that I'm not great at documentation. Any help to improve it
would be very much appreciated. The best way is to open an issue on
the tracker with your patch attached and then drop a message to the
selenium-developers list (as there's an awful lot of emails generated
by the bug tracker :)

Many thanks!

Simon

[Mike]

I have submitted issue 2063 with the patch files for both server and
client with the changes I made. In some cases, such a @return tags, I
simply put down the type of object being returned. I would suggest
that if possible people responsible (or at least more knowledgeable
than I) review the suggested changes.

I hope to be able to contribute more as time goes on and I get to
understand how all this works, but at least I could do this much for
now.

I still need to experiment and check into why so many of the @link and
@see tags get warning messages. I haven't had the time to try running
it with go.bat yet to see if that is what you are expecting to see or
not.

Mike

[Simon Stewart]

Thank you, Mike. I'll have a look at these on Monday. Could you please
also sign the CLA?

https://spreadsheets.google.com/spreadsheet/viewform?hl=en_US&formkey=dFFjXzBzM1VwekFlOWFWMjFFRjJMRFE6MQ#gid=0

We need this to be sure that we can include your changes into the
codebase (I know it's a PITA, and I apologise for that)

Simon

[Mike]

Not a problem. Done.

I had a chance to try and eliminate some of the @link issues this
morning, but what I tried didn't work. Maybe finding some where it
doesn't complain about them will give me a clue later...

Mike

On Jul 17, 10:13 am, Simon Stewart <simon.m.stew...@gmail.com> wrote:
> Thank you, Mike. I'll have a look at these on Monday. Could you please
> also sign the CLA?
>

> https://spreadsheets.google.com/spreadsheet/viewform?hl=en_US&formkey...