commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Daniel F. Savarese" <...@savarese.org>
Subject Re: [net] Javadoc question
Date Mon, 28 Jun 2004 03:51:45 GMT

In message <200406271720.44237.scohen@javactivity.org>, Steve Cohen writes:
>These broken links are almost all of the following form
>
><a href = "org.apache.commons.net.package..../Class.html">
>
>Of course, these won't work.  
>
>Can someone help me answer these questions?
>
>How did they ever work?  
>Is this the result of some global search and replace gone awry?
>What is the "right" way to express such links in javadoc?  Relative paths?  is

Before there was ever a link tag, JDK 1.1 javadoc generated files of the
form packagename.classname.html  The only way to reference them was directly.
Somewhere in the migration process from NetComponents to Commons Net, the
links must have been overlooked, but got the org.apache.commons.net in
them from a substitution to fix up the package names.  It should be easy
enough to do a
find src/ -name "*.java" -print | xargs \
  perl -pi -e 's/<a\s+href="([^"]+)\.html">/{\@link $1}/g' \
           -e 's/<a\s+href="([^"]+)\.html(#[^"]+)">/{\@link $1$2}/g'
to fix most of it up.  The substitution expressions are off the top of my
head and surely need tweaking; they also generate fully qualified class names.
If you want, I can fix it up.

daniel



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


Mime
View raw message