Summary: | @deprecated has to be at the beginning of the comment line | ||
---|---|---|---|
Product: | [Eclipse Project] JDT | Reporter: | Olivier Thomann <Olivier_Thomann> |
Component: | Core | Assignee: | Olivier Thomann <Olivier_Thomann> |
Status: | VERIFIED FIXED | QA Contact: | |
Severity: | normal | ||
Priority: | P3 | ||
Version: | 2.1 | ||
Target Milestone: | 2.1 M5 | ||
Hardware: | PC | ||
OS: | Windows 2000 | ||
Whiteboard: |
Description
Olivier Thomann
2002-12-17 15:36:10 EST
Please find some official confirmation of this behavior This is stated in the javadoc specs. Any tag has to be at the beginning of the line preceeded only with whitespaces and/or a asterisk. From this link: http://java.sun.com/j2se/1.4/docs/tooldocs/windows/javadoc.html Standalone and in-line tags - A tag is a special keyword within a doc comment that the Javadoc tool can process. The Javadoc tool has standalone tags, which appear as @tag, and in-line tags, which appear within braces, as {@tag}. To be interpreted, a standalone tag must appear at the beginning of a line, ignoring leading asterisks, white space, and separator (/**). This means you can use the @ character elsewhere in the text and it will not be interpreted as the start of a tag. If you want to start a line with the @ character and not have it be interpreted, use the HTML entity @. Each standalone tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the doc comment. This associated text can span multiple lines. An in-line tag is allowed and interpreted anywhere that text is allowed. The following example contains the standalone tag @deprecated and in-line tag {@link}. Fixed and released in 2.1 stream. Verified. |