Eclipse Community Forums: Eclipse Platform

Home » Eclipse Projects » Eclipse Platform » @See in javadoc?

Sun, 26 September 2004 17:48

Eclipse User

Originally posted by: Bruce2004.stempsoft.com

Sorry for the "newbie" question but I am trying to document my classes
so just started playing with javaDoc.

I inserted an @See in my comments.

/**
*@return Returns the Date and time of the Garmin GPS.
*@See Gps#rxDateTime()
*/

But the JavaDoc compiler complains:

D:\MyProjects\java\Eclipse\Garxface\GarXface\com\stempsoft\g arxface\Gps.java:408:
warning - @See is an unknown tag -- same as a known tag except for case.

I really don't understand why I am getting this warining. Gps is my class
and rxDateTime() is the method. Can someone please tell me what is wrong?

Is there anyway to use auto code assist to help pick the various classes
and methods within your porject when typint @See? If so how?

Re: @See in javadoc? [message #272712 is a reply to message #272711]

Sun, 26 September 2004 18:12

Eclipse User

Originally posted by: news.karsten-becker.de

Bruce wrote:
> I really don't understand why I am getting this warining. Gps is my class
> and rxDateTime() is the method. Can someone please tell me what is wrong?
Did you try it in lowercase?
@see javadoc :-)

Karsten

Re: @See in javadoc? [message #272713 is a reply to message #272712]

Sun, 26 September 2004 19:08

Eclipse User

Originally posted by: Bruce2004.stempsoft.com

I feel so stupid! :}

Thanks! And code assist works too!

So how can I do multiple links?

@see Gps#rxDateTime() java.util.GregorianCalendar

does not seem to work.

also tried

@see Gps#rxDateTime()
@see java.util.GregorianCalendar

Karsten Becker wrote:

> Did you try it in lowercase?
> @see javadoc :-)

> Karsten

Re: @See in javadoc? [message #272731 is a reply to message #272713]

Mon, 27 September 2004 06:23

Eclipse User

Originally posted by: bob.news.gmx.net

"Bruce" <Bruce2004@stempsoft.com> schrieb im Newsbeitrag
news:cj7i55$95r$1@eclipse.org...
> I feel so stupid! :}
>
> Thanks! And code assist works too!
>
> So how can I do multiple links?
>
> @see Gps#rxDateTime() java.util.GregorianCalendar
>
> does not seem to work.
>
> also tried
>
> @see Gps#rxDateTime()
> @see java.util.GregorianCalendar

And, did it work?

robert

Previous Topic:	Editors using non-file resources
Next Topic:	How do I close resources offline?

Goto Forum:

-=] Back to Top [=-

Current Time: Sun Jun 01 19:50:26 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter