[jira] Commented: (MAVEN-694) add offline javadoc generation

[ji...@codehaus.org]

The following comment has been added to this issue:

     Author: Simon Matic Langford
    Created: Tue, 19 Aug 2003 4:26 AM
       Body:
to do offline links while offline, or online links while online, you need to point to the url you want it at. this should be ok, as you just leave maven.javadoc.mode.online=${maven.mode.online} and fill in the appropriate property.

and to do offline links while online should be no prob with the suggestion, just change maven.javadoc.mode.online=false when online


Not sure exactly how to do online links while offline, here is a snippet of an ant javadoc task:


    <javadoc packagenames="com.pcmsgroup.v21.*"
      sourcepath="${src}/"
      destdir="${javadoc}/" ....>
      <link href="http://java.sun.com/j2se/1.3/docs/api/" offline="true" 
            packagelistLoc="${inf.dir}/make"/>
      <link href="../../${inf}/${javadoc}" offline="true" 
            packagelistLoc="${inf.dir}/${javadoc}"/>
      <link href="../../${boi}/${javadoc}" offline="true" 
            packagelistLoc="${boi.dir}/${javadoc}"/>
      <link href="../../${ui}/${javadoc}" offline="true" 
            packagelistLoc="${ui.dir}/${javadoc}"/>
      <link href="../../${base}/${javadoc}" offline="true" 
            packagelistLoc="${base.dir}/${javadoc}"/>
      <link href="../../${posui}/${javadoc}" offline="true" 
            packagelistLoc="${posui.dir}/${javadoc}"/>
    </javadoc>

so you would need to specify 2 urls for each package, one for the url the docs are at, and one for the location of the packagelist.
---------------------------------------------------------------------
View the issue:

  http://jira.codehaus.org/secure/ViewIssue.jspa?key=MAVEN-694


Here is an overview of the issue:
---------------------------------------------------------------------
        Key: MAVEN-694
    Summary: add offline javadoc generation
       Type: Improvement

     Status: Unassigned
   Priority: Major

 Time Spent: Unknown
  Remaining: 2 hours

    Project: maven
 Components: 
             plugin-javadoc
   Versions:
             1.0-beta-10
             maven-new-unreleased
             1.0-final
             1.0-rc1
             1.1

   Assignee: 
   Reporter: Martin Skopp

    Created: Tue, 19 Aug 2003 2:30 AM
    Updated: Tue, 19 Aug 2003 2:30 AM
Environment: all

Description:
I am willing to assist but have no commit rights.
So if a committer takes this issue, feel free to contact me to split work...

This feature request splits into several parts, see also Thread "About Javadoc links" @maven-user.

i) Add "javadoc -linkoffline" usage
=================================
Extends javadoc plugin to respect a new property "maven.javadoc.offlineLinks" when in offline mode (maven.mode.online=false).

ii) Add option to generate offline javadoc even when online
===========================================================
Could be extremely useful for users behind a proxy (see Simons post) OR laptop users which work online in the office, but like to generate all javadoc API with OFFLINE links, since they frequently travel and have all the APIs on their own harddrive - so they want to have OFFLINE links instead of ONLINE links.
I suggest a new property
  maven.javadoc.mode.online=false|true
with default value =maven.mode.online !

Martin Skopp <sk...@riege.de>


Original posts for your reference:
------------------------------------------------
Paul Libbrecht <pa...@activemath.org>
Date:?	Wed, 13 Aug 2003 11:31:10 +0200	

I realized however that it would be good if a user could override such a link-offline/link-online for each packages. The reason is that a local javadoc is quite often available and it makes lots of sense for a javadoc to actually get linked to other local javadocs.

Could there be properties such as:

maven.javadoc-plugin.links.<projectName>.url =
maven.javadoc-plugin.links.<projectName>.offlineUrl =

This way, people only interested into building their snapshot of a 
javadoc of a local project could do so in user-level properties...
------------------------------------------------
Martin Skopp <sk...@riege.de>:

There's already this "maven.javadoc.links" property where you specify
the link-ONLINE urls, packages seperated by comma.

Sad thing is that the javadoc plugins ignores the link-ONLINE completely
when in offline mode:

--- SNIP ---
??????? <j:when test="${maven.mode.online}"/>
??????? <j:otherwise>
????????? <j:set var="maven.javadoc.links" value=""/>
??????? </j:otherwise>
--- SNIP ---

IMHO a property "maven.javadoc.offlineLinks" could be helpful.? And the javadoc plugin needs to respect it...

Offline javadoc links could be VERY helpful, e.g. when you travel with
your laptop and you like to read the API doc...
------------------------------------------------
Simon Matic Langford <si...@pcmsgroup.com>

we'd actually like to do the offline links even when online, as javadoc can't go through a proxy.


Good idea, that would make one additional property
javadoc.mode.online=false...


---------------------------------------------------------------------
JIRA INFORMATION:
This message is automatically generated by JIRA.

If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa

If you want more information on JIRA, or have a bug to report see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org