Hi,
I wish to extend the normal javadoc in subtle and not-so-subtle ways. I
can't seem to find the xdoclet task or template to simply create plain
javadoc, which I would think would be the best jumping off point.
Specifically, I would like to be able to use the hyperlinks to javadoc pages
that javadoc generates.
The idea is that of my API, only certain members are interesting to newbies,
so I just want a list of those methods, linked to the full javadoc.
I *was* able to succesfully use the "info" subtask to customize a three-pane
browser window for my tag "@dynamide.keymethod" a la the @todo example.
However, this is missing the links to the real javadoc. I would like a
javadoc-y page that filters *only* those methods with "@dynamide.keymethod"
and produces regular javadoc for those methods. Alternatively, I think a
single page that had all the key methods in my classes listed, with links to
the real javadoc (I can provide a base URL) would be slick.
If there is no test case in xdoclet that produces vanilla javadoc, then
perhaps someone could point me at the correct way to generate a hyperlink to
a method within a class that is overloaded with multiple parameters, since
this is what javadoc is capable of. e.g., this seems to be the hard way
(removing some of the html brackets for email discussion ...)
a
href="<XDtClass:fullClassName/>#<XDtMethod:methodName/>(<XDtParameter:parame
terList/>)"> <XDtMethod:methodName/>
For one thing, this would generate:
a href="com.dynamide.Session#createNewSession(java.lang.String
urlPath,boolean designMode) createNewSession
but this is incorrect, because what javadoc generates, (and what I want to
jump to) is:
a href="/com/dynamide/Session.html#createNewSession(java.lang.String,
boolean)
As you can see, the fullClassName method returns a dotted name, and javadoc
produces subfolders using the package names, so slashes are required instead
of dots. Also, the types are required, not the parameter names with types.
I suppose I could overload the task with my own task to munge the string
into correctness, but this feels wrong.
At any rate, helping me with this example might be giving me a fish, whereas
pointing me to how to create standard javadoc would be *teaching* me to
fish. :)
Any suggestions would be much appreciated.
thanks,
Laramie
-------------------------------------------------------
This SF.NET email is sponsored by: eBay
Great deals on office technology -- on eBay now! Click here:
http://adfarm.mediaplex.com/ad/ck/711-11697-6916-5
_______________________________________________
xdoclet-user mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-user
