Menu

#300 Bugs in Javadoc format

open
5
2008-12-05
2008-12-05
No

File test_epydoc.py contains:

----------------------------------------------------------------------------
class A(object):
"""Class A

@see B
@see C
"""
pass

class B(A):
"""Class B"""
pass

class C(A):
"""Class C"""
pass
----------------------------------------------------------------------------

Using Epydoc, version 3.0.1 and running the following command:

epydoc -v --docformat javadoc test_epydoc.py

Produces:

----------------------------------------------------------------------------
Class A

source code

object --+
|
A

Known Subclasses:
□ B
□ , C

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Class A
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

See Also:
, C
----------------------------------------------------------------------------

Notice how the "Known Subclasses" is wrong, and the "See Also" cross-references as well.

Discussion


Log in to post a comment.