GNOME Bugzilla – Bug 700788
support @cite within brief description (was: probably unintentional modification of behaviour of @copydetails)
Last modified: 2013-05-30 19:33:46 UTC
Hello, As discussed here: https://bugzilla.gnome.org/show_bug.cgi?id=692320 the current SVN version of Doxygen behaves differently than 1.8.3 when doing @copydetails. Here's a short example: $ cat a.hpp /// @file a.hpp /// @details /// some text @copydetails a some other text /// @brief brief /// @details details of a struct a {}; $ doxygen -g $ doxygen (doxygen-svn) $ fgrep "details of a" html/* html/a_8hpp.html:<p>details of a </p> html/structa.html:<p>details of a </p> (doxygen 1.8.3) $ fgrep "details of a" html/* html/a_8hpp.html:<div class="textblock"><p>some textdetails of a some other text </p> html/structa.html:<p>details of a </p> Even if it is somehow an intended behaviour, it would be great to have the possibility to switch to the old one, i.e. inclusion of the "details" without the surrounding <p></p>. Thanks, Sylwester
Note that this issue is also discussed in comments for #691315 https://bugzilla.gnome.org/show_bug.cgi?id=691315#c6
I've marked this as a duplicate. The fix proposed in #691315 should also solve this issue. *** This bug has been marked as a duplicate of bug 691315 ***
Thanks. However, it the particular case in which I've noticed the buggy behaviour it does not really help entirely. The following header: ------------------------------------------------------------------------ /** @file * @copyright University of Warsaw * @brief single-moment bulk parameterisation formulae (Kessler) * from @copydetails bib::Grabowski_and_Smolarkiewicz_1996 * @section LICENSE * GPLv3+ (see the COPYING file or http://www.gnu.org/licenses/) */ ... ------------------------------------------------------------------------ Is converted into: ------------------------------------------------------------------------ ... <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>single-moment bulk parameterisation formulae (Kessler) from </p> <dl class="section copyright"><dt>Copyright</dt><dd>University of Warsaw <a href="http://dx.doi.org/TODO">Grabowski and Smolarkiewicz 1996</a> </dd></dl> <h1><a class="anchor" id="LICENSE"></a> LICENSE</h1> <p>GPLv3+ (see the COPYING file or <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>) </p> ... ------------------------------------------------------------------------ what is rendered as: ------------------------------------------------------------------------ ... single-moment bulk parameterisation formulae (Kessler) from Copyright University of Warsaw Grabowski and Smolarkiewicz 1996 LICENSE GPLv3+ (see the COPYING file or http://www.gnu.org/licenses/) ... ------------------------------------------------------------------------ (notice that the copyright field is merged with the output from @copydetails which is not in @copyright, but in @brief) Help very welcome! Thanks, Sylwester
Please attach a self contained example (source plus config file in a tar or zip) so I can reproduce the problem.
Created attachment 245359 [details] a self-contained example showing the problem described in comment #3 Here it is (sorry for not shortening it, but since the problem is yet in the file header, I guess the rest of the file does not obscure it). Thanks, Sylwester
Hi Sylwester, The problem with your example is that @copydetails will end the brief description. You cannot "paste" the contents of a detailed description in a brief description. The reason: a detailed description allows stuff that is not supported in a brief description (lists, tables, etc). At the point were doxygen decides what should end up as brief and what as detailed, the @copydetails cannot be processed yet. So I don't want to support this. You could use @copybrief instead. For Bibtex references doxygen has @cite. This command is currently not allowed in a brief description either, but I think it is possible to support this.
Thanks for looking at it and for the explanation. I've renamed the issue to "support @cite within brief description (was: ...)". Sylwester
Issue with @cite inside brief should be fixed in the next GIT update. *** This bug has been marked as a duplicate of bug 684324 ***