I've been documenting my OOD assignment code using javadoc
, which is The Right Thing To Do(tm).
Which is all well and good except that javadoc doesn't have either a "precondition" or "postcondition" tag built in.
I included @pre and @post tags in my comments, then ran javadoc like this:
$ javadoc ---tag pre:a:"Precondition" ---tag post:a:"Postcondition" ---private ---d docs \*java
which gave me the unexpected and unwarranted message
Note: Custom tags that could override future standard tags: @precondition, @postcondition. To avoid potential overrides, use at least one period character (.) in custom tag names.
Note: Custom tags that were not seen: @precondition, @postcondition
Hang on a minute, I just specified those tags on my command line? What's going on?
I tried using ---taglet instead of ---tag, but still no success:
javadoc: error --- Error --- Exception java.lang.ClassNotFoundException thrown while trying to register Taglet precondition:a:Precondition...
javadoc: error --- Error --- Exception java.lang.ClassNotFoundException thrown while trying to register Taglet postcondition:a:Postcondition...
not that I really expected this one to work, since I haven't defined a taglet or doclet to go with the pre- and post-condition tags.
What should I do? Is this a bug in javadoc (1.5.0_01 on Solaris Nevada build 24 + nightlies) ?