Apache OpenOffice (AOO) Bugzilla – Issue 69082
autodoc strips all content after a @see tag
Last modified: 2007-04-27 17:10:04 UTC
Compare http://api.openoffice.org/docs/common/ref/com/sun/star/sdb/RowSet.html with http://api.openoffice.org/source/browse/api/offapi/com/sun/star/sdb/RowSet.idl?rev=1.20&only_with_tag=OpenOffice_2_0_3&view=markup In the RowSet.idl file, there is an *extensive* documentation for the class as a whole. However, as you can see in the online IDL reference, nearly *all* of this documentation is simply not available. Playing around reveals that autodoc seems to strip all content in the current comment block after it encountered the first block of @see tags - which certainly is not desired.
This is a regression, it used to work previously. Compare revisions 1.5 and 1.6 of RowSet.html: http://api.openoffice.org/source/browse/api/www/docs/common/ref/com/sun/star/sdb/RowSet.html?rev=1.6&view=markup http://api.openoffice.org/source/browse/api/www/docs/common/ref/com/sun/star/sdb/RowSet.html?rev=1.5&view=markup I assume that's a side effect of consolidating the "Ses Also" information into one instead of multiple paragraphs. I consider this a blocker for the IDL reference to be put online for 2.0.4 - I use @see quite often in various contexts, and the current behaviour simply strips a lot of useful information in various places.
One cannot continue the "description" of an elements docu after the first @-tag. In Rev 1.5 of the above example, the following text is part of the @see tag, not of the description. The previous use of @see tags was not according to documentation: http://api.openoffice.org/docs/DevelopersGuide/Appendix/IDLDocumentationGuide/IDLDocumentationGuide.xhtml#1_3_1_3__40-Tagged_Part However, I see that in that same document the @see-tag allows further documentation. This is indeed not preserved by the "consolidated" @see tags. So the situation seems to be: 1. @see-tag needs a fix in Autodoc to allow further comments within the tag. 2. Use of @see in the middle of a description is wrong and those documentation should be changed.
Now, @see tags without additional tags are combined into one output-paragraph. @sees with additional text get an extra paragraph.
.
verified
set target to 2.1
has been integrated into m185.