Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.java.programmer > #34733

Re: @see enhancements

Show all headers | View raw

On Wednesday, June 29, 2016 at 12:54:10 AM UTC-7, Roedy Green wrote:
> I would like to see three enhancements to the @see Javadoc tag.
> 
> 1. @see Class#method(Type, Type,...) should alternatively be written.
> @see Class.method(Type, Type,...) 
> The # was an html hack.

The '#' is the canonical way to represent an instance member of a class, distinguished from '.' which refers to a static method. It is not an "html [sic] hack" but a Javadoc convention with a real purpose. Your suggestion would cause confusion and is not a good idea.

> 2. You should be allowed to put some text after the @see link to
> explain what you will find there, or why our might want to look there.
> eg. @see com.mindprod.stores.BulkProber to see the definitions of the
> environment variable probes.

You can achieve some of what you want here using '@see "string"'
http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#see 

> 3. the IDE should treat see links just like references, so for example
> by clicking the see and hitting Ctrl-B in IntelliJ, you would see the
> definition of the corresponding code.

That's not an enhancement to '@see' but to IntelliJ.

-- 
Lew

Back to comp.lang.java.programmer | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

@see enhancements Roedy Green <inquiry@mindprod.com> - 2016-06-29 00:53 -0700
  Re: @see enhancements Lew <lewbloch@gmail.com> - 2016-06-30 11:15 -0700
    Re: @see enhancements Roedy Green <inquiry@mindprod.com> - 2016-07-03 22:39 -0700
    Re: @see enhancements Roedy Green <inquiry@mindprod.com> - 2016-07-03 22:28 -0700

csiph-web