Bugs item #1969190, was opened at 2008-05-21 22:37
Message generated for change (Comment added) made by cjuergen
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=119984&aid=1969190&group_id=19984

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: None
>Status: Closed
>Resolution: Fixed
Priority: 5
Private: No
Submitted By: Larry Stone (lcs8)
Assigned to: Nobody/Anonymous (nobody)
Summary: javadoc creation documented wrong and/or broken

Initial Comment:
Following the directions in dspace/docs/introduction.html to build the 
javadocs: 
"Build these with the command mvn javadoc:javadoc" makes some noise with maven 
but produces nothing.

Actually, the documentation says nothign about what _directory_ you cd to 
before running mvn javadoc:javadoc. It turns out, if you are in the 
"dspace-api" subdirectory of the 1.5 source release, it produces javadocs under 
target/site/apidocs

However, this same gambit doesn't work for OAI.

Should the high-level POMs be fixed to make this work from the top level?  
Should the documentation be  clarified, or at least the misleading doc removed?

Please expand the documentation to include, for 
each component of the system if necessary,

1. the current directory from which to run maven javadoc:javadoc
2. the output directory in which to look for apidocs

My environment:
Linux, i386, Sun java 1.5.0_13, Maven version: 2.0.7,
using DSpace 1.5.0 source release downloaded from SF

----------------------------------------------------------------------

>Comment By: Claudia Juergen (cjuergen)
Date: 2009-01-20 15:21

Message:
Running mvn javadoc.javadoc from [dspace-source]/dspace as indicated in the
DSpace 1.5.1 manual
"The storage and business logic layer APIs are extensively documented with
Javadoc-style comments. Generate the HTML version of these by entering the
[dspace-source]/dspace directory and running: mvn javadoc:javadoc"
works ok.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=119984&aid=1969190&group_id=19984

------------------------------------------------------------------------------
This SF.net email is sponsored by:
SourcForge Community
SourceForge wants to tell your story.
http://p.sf.net/sfu/sf-spreadtheword
_______________________________________________
Dspace-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/dspace-devel

Reply via email to