Generic Inlined tags
Hi,
I sent the following mail to the Sun guys.
I am thinking of using the {@link ... } tags as a workaround. Instead of the normal semantics of
{@link package.class#member label}, I plan to use it as:
{@link type_of_tag text_body_of_tag}
e.g.,
{@link code
// Some example code can be put here
Vector v =new Vector();
...
}
{@link emailid schabungbam@hss.hns.com}
{@link rcsid $Id: ...$}
I know this is crude, but it seems to be working at the moment.
Has anyone faced similar problem? Is there a better solution?
regards,
Sameer.
======================
Hi,
I am using javadoc 1.3 to generate API documentation for a project. We plan to use javadocs extensively to document the code and generate the API documentaion from the code.
However, in a javadoc comment, while we can have custom "regular" tags, it seems that we just cant have any custom "inlined" comment. That is, is there a way where I can write javadoc like the following?
====
/**
* Example Java document.
*
* {@code
*Vector v = new Vector();
*// some code can go here ...
* }
*
* For more information, contact {@emailid schabungbam@hss.hns.com}.
*
* {@rcsid $Id: ... $}
*
* @regulartag this is fine
*/
====
The main problem comes when we insert HTML tags inside the Javadoc, As long as we are generating HTML, it suits us. But the moment we use some other output format like RTF, etc, we have to parse the HTML tags. This is very nagging. Use of custom inlined tags will allow us to define our own tags, which we can easily parse - using the Javadoc API, and nothing else.
Can we expect this feature in the near future?
regards,
Sameer.
