JDK-4115787 : Mapping of e-mail addresses within @authour tags
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.2.0
  • Priority: P5
  • Status: Closed
  • Resolution: Duplicate
  • OS: windows_95
  • CPU: x86
  • Submitted: 1998-02-26
  • Updated: 2014-05-05
  • Resolved: 1998-04-13
Related Reports
Duplicate :  
JDK-4097252 - Add syntax to generate in-line @see links in descriptions and tag text
Description

Name: rm29839			Date: 02/26/98


What I'd like to see is a way of automatically parsing an Author's e-mail address
so that it gets formatted nicely for HTML output.

An e-mail address in the author field should be quite easy to pick out,
since it will be easily detectable using a regular expression (probably
even integratable into the lexical analyser for javadoc ...)

Once the e-mail address has been detected, then it would be nice to have:

@author Alex Blewitt <###@###.###>

translated into:

Alex Blewitt &lt;<a href="mailto:###@###.###"><address>###@###.###</address></a>&gt;

I'm not sure if the specific <> could be detected/would want to be detected or passed through as an HTML tag or not.
The only reason for suggesting the <> is because that a fair number of (text based) e-mail programs use it
to determine the difference between a
text display name and an e-mail address.
(Review ID: 25703)
======================================================================
Comments
EVALUATION This is a case where the person could write his own doclet, and could define a new in-line tag {@mailto} tag that could go anywhere in text: @author Alex Blewitt {@mailto ###@###.###} Although Robert is unmoved, I think this is worth considering after 1.2. @mailto could be implemented both as an inline and standalone tag. The standalone use might be useful for groups of engineers: @mailto mr.big@eng Bob, Architect @mailto joe.shmo@eng Joe, Lead programmer @mailto ms.tuffet@eng Jill, Writer doug.kramer@Eng 1998-04-03
11-06-2004
WORK AROUND Name: rm29839 Date: 02/26/98 Just type the details in manually ======================================================================
11-06-2004