File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Maven and javadoc Big Moose Saloon
  Search | Java FAQ | Recent Topics
Register / Login


JavaRanch » Java Forums » Professional Certification » Developer Certification (SCJD/OCMJD)
Reply Bookmark "Maven and javadoc" Watch "Maven and javadoc" New topic
Author

Maven and javadoc

Mans Schultz
Greenhorn

Joined: Mar 17, 2010
Posts: 4
Hello

I have some small question about the delivery requirements. Since sun can't be contacted at any email right now I thought I would ask here.

I use maven to generate my javadoc for the assignment. This seemed natural at first but lately the requirements got me thinking. Is this really ok or does it break the rule that you can't submit code that isn''t your own? Maven does generate files so I will be submitting files that I have not written (even if I wrote the code the javadoc is based on). Then again, html files are not code and suns own javadoc tools also generates files.

Also is there a consensus on where to place test files in the delivery jar? Since the test classes should not be included in the application jar it seems wrong to keep them along with the rest of the code/javadoc. Nor do I want them to be omitted completly. Alot of my design choices are based around testability so the test classes are a major part of the general design. Do I risk an auto-fail if I add another folder for the tests?

What do you guys think?

Thanks

/
Måns
Roel De Nijs
Bartender

Joined: Jul 19, 2004
Posts: 3740

Hi Mans,

First of all a warm welcome to the JavaRanch!

1/ I generated my submission jar with an Ant build file, so the javadoc was also not my own. But it isn't code, so you won't be breaking that rule.

2/ I would simply submit only the files that are needed.

Kind regards,
Roel


SCJA, SCJP (1.4 | 5.0 | 6.0), SCJD
http://www.javaroe.be/
Roberto Perillo
Bartender

Joined: Dec 28, 2007
Posts: 2114

Howdy, Mans. Welcome to JavaRanch!

Roel De Nijs wrote:
1/ I generated my submission jar with an Ant build file, so the javadoc was also not my own. But it isn't code, so you won't be breaking that rule.

2/ I would simply submit only the files that are needed.


100% agreed. In order to generate the necessary files (or verify if your structure is correct), you might want to take a look at Roel's super cool submission .jar assembler.


Cheers, Bob "John Lennon" Perillo
SCJP, SCWCD, SCJD, SCBCD - Daileon: A Tool for Enabling Domain Annotations
Mans Schultz
Greenhorn

Joined: Mar 17, 2010
Posts: 4
Thank you for the quick replies!

I understand the issue with submitting files that aren't needed, you have everything to loose and nothing to win. But I feel that my unit tests are a big part of motivating my design. Im afraid that some parts won't be understood without the tests. Is it perhaps better to rewrite the design so it can be more easily motivated (but not as testable) since the tests can't be submitted?

This message was edited 1 time. Last update was at by Mans Schultz

Roberto Perillo
Bartender

Joined: Dec 28, 2007
Posts: 2114

Howdy, Mans!

But I feel that my unit tests are a big part of motivating my design. Im afraid that some parts won't be understood without the tests. Is it perhaps better to rewrite the design so it can be more easily motivated (but not as testable) since the tests can't be submitted?


Well champion, it is not that they can't be submitted, you know... but it is better to stick to what is asked. And if your design is sort of hard to understand without the tests, then maybe it would be better to think about it again, because the simpler your solution is, the better!
Mans Schultz
Greenhorn

Joined: Mar 17, 2010
Posts: 4
I took your council and excluded the tests. Better safe than sorry.

Thanks for the advice.
 
 
subject: Maven and javadoc
 
MyEclipse, The Clear Choice