create new tag
, view all tags

JavaDocPluginDev Discussion: Page for developer collaboration, enhancement requests, patches and improved versions on JavaDocPlugin contributed by the TWikiCommunity.
• Please let us know what you think of this extension.
• For support, check the existing questions, or ask a new support question in the Support web!
• Please report bugs below

Feedback on JavaDocPlugin

Very useful plugin - but couldn't make it point at an anchor within a Javadoc page - eg I would expect :


to generate http://server/Java/jdk-1.3.1/docs/api/java/lang/String.html#toLowerCase() which would point directly at the method.

It actually generates :


-- LaurentBovet - 04 Apr 2003

There is an error in JavaDocPlugin.pm, line 116. When the JavaDocPlugin topic is processed, the following error message is displayed:

Unmatched right curly bracket at ../lib/TWiki/Plugins/JavaDocPlugin.pm line 118, at end of line
syntax error at ../lib/TWiki/Plugins/JavaDocPlugin.pm line 118, near "}"
Compilation failed in require at (eval 16) line 1.

Fix is (screenshot from vim):

 116      return '<A HREF="' . $prefix . $path . '.html">' . $parray[$#parray] . "<        /A>";
 117      #     }
 118 }
"~/twiki20030201/lib/TWiki/Plugins/JavaDocPlugin.pm" 122 lines --95%--

-- LudovicTant - 13 May 2003

is there any plans for the reverse of this? I.e. a JavaDoc Doclet that checks to see whether WikiWords are in the javadoc and if so link them to wiki? I guess this wouldn't be too hard to write...

-- GilesCope - 03 Jun 2003

This plugin does not work for Package summaries, ie. %JAVADOC{java.lang}% links to http://.../api/java/lang.html instead of http://.../api/java/lang/package-summary.html. This should be easy to detect, since for packages the last part starts with a lowercase char.

-- ChristopherHuhn - 06 Nov 2003

Contrary to the statement in JavaDocPlugin, the plugin topic is installed to data/*Plugins*/JavaDocPlugin.txt, should be data/*TWiki*/JavaDocPlugin.txt.

-- ChristopherHuhn - 02 Feb 2005

.zip checked into CVS

-- WillNorris - 27 Jun 2005

In Dakar you get complains with:


replace it with


-- AndreasBaumann - 12 Jan 2006

On Dakar 4.0.1, after commenting out the extra brace on line 119 in JavaDocPlugin.pm (at this point plugin is listed on InstalledPlugins page with no errors, and moving JavaDocPlugin.txt to twiki/data/TWiki, I get the following error when I click on the JavaDocPlugin information page.

ontent-type: text/plain

TWiki detected an internal error - please check your TWiki logs and webserver logs for more information.

Can't use string ("JAVADOCPLUGIN_L4J") as a HASH ref while "strict refs" in use

So .. haven't been able to get it work on Dakar 4.0.1 yet.

-- KalDe - 25 Mar 2006

To the Plugin maintainer: This Plugin does not work in TWiki 4.0. Please consider upgrading this Plugin so that it runs on Cairo and Dakar codebase. HandlingCairoDakarPluginDifferences has more.

Kal: Feel free to fix & re-upload this Plugin, it has a PleaseFeelFreeToModify poclicy. If you want, contact the author by e-mail first.

-- PeterThoeny - 25 Mar 2006

I got this to work on TWiki 4.0.4 just now. Had to replace $prefix = TWiki::Prefs::getPreferencesValue("JAVADOCPLUGIN_" . $args[0]);


$prefix = TWiki::Func::getPreferencesValue("JAVADOCPLUGIN_" . $args[0]);

I'm not a plugin developer, so I wont update this, but wanted to pass on the information in case anyone else knows more about this than me and can properly update it.

-- AnthonyTuel - 02 Aug 2006

Thanks Anthony for sharing this. This is a trivial change, someone will probably pick it up and publish a fixed version.

-- PeterThoeny - 03 Aug 2006

Made the trivial changes to get it working on 4.0.4 and uploaded it

-- HolgerHellmuth - 08 Nov 2006

Wonderful plugin, thanks. I'm not able to link to nested (static inner) classes. The final . needs to stand alone. Is there another character (#?) that will get translated into a . in the final link? For example, looking for a link to Map.Entry.

-- BarettMcgavock - 2011-06-01

Edit | Attach | Watch | Print version | History: r15 < r14 < r13 < r12 < r11 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r15 - 2011-06-01 - BarettMcgavock
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.