GNOME Bugzilla – Bug 348729
@copydoc causes JAVADOC_AUTOBRIEF to fail
Last modified: 2009-12-28 03:54:25 UTC
Please describe the problem: I have recently discovered that when @copydoc is used to copy the documentation of an interface method to the implementation method (as in the following example), the entire documentation is used in place of the brief description in the Public Member Functions list. Steps to reproduce: 1. Turn on JAVADOC_AUTOBRIEF in the configuration 2. Document an interface method as follows for class IDocument: /** Set document compression level. * The compression levels range from 0 which is no compression to 9 which is the highest compression. * @param compression Compression level from 0 to 9 */ virtual void setCompression (CCL_uint32 compression) = 0 ; 3. Document the implementation method in class Document as follows: /** @copydoc IDocument::setCompression */ void setCompression (CCL_uint32 compression) = 0 ; 4. Generate the documentation 5. Open the documentation to the interface method and view its brief description in the list of Public Member Functions. 5. Open the documentation for the implementation method and view its brief description in the list of Public Member Functions. Note that it isn't brief. Actual results: The hyperlinked Public Member Functions list for the implementation class contains more than just the brief description, it also contains the long description as well as the parameter documentation and any other documentation added to the interface documentation are displayed in place of the brief description. The Member Function Documentation is correct as it is supposed to display the entire documentation. Expected results: Only the brief description should be displayed in the list of Public Member Functions and the details should only be displayed in the Member Function Documentation. Does this happen every time? Yes Other information:
Please note that: @copydoc copies both brief and detailed descriptions. @copybrief copies only the brief description. @copydetails copies only the detailed description. Can you check if this information solves your problem or if the problem is still present in version 1.5.9 or later? If it is still present it would help me if you could attach a self-contained example (source + config file) that allows me to reproduce the problem.
Closing this bug report as no further information has been provided. Please feel free to reopen this bug if you can provide the information asked for. Thanks!