Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

support @cite within brief description (was: probably unintentional modification of behaviour of @copydetails) (Origin: bugzilla #700788) #5192

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Copy link
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.8.3.1-SVN on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2013-05-21 16:43:35 +0000, Sylwester Arabas wrote:

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:

details of a


html/structa.html:

details of a

(doxygen 1.8.3)
$ fgrep "details of a" html/*
html/a_8hpp.html:

some textdetails of a some other
text


html/structa.html:

details of a

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

.

Thanks,
Sylwester

On 2013-05-23 18:17:12 +0000, Kyle wrote:

Note that this issue is also discussed in comments for # 691315

https://bugzilla.gnome.org/show_bug.cgi?id=691315#c6

On 2013-05-26 19:14:37 +0000, Dimitri van Heesch wrote:

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 ***

On 2013-05-26 20:04:34 +0000, Sylwester Arabas wrote:

Thanks. However, it the particular case in which I've noticed the buggy behaviour it does not really help entirely.

The following header:


/** @file


Is converted into:


...

Detailed Description

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/)

... ------------------------------------------------------------------------

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

On 2013-05-26 20:56:37 +0000, Dimitri van Heesch wrote:

Please attach a self contained example (source plus config file in a tar or zip) so I can reproduce the problem.

On 2013-05-26 21:07:43 +0000, Sylwester Arabas wrote:

Created attachment 245359
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

On 2013-05-27 17:24:54 +0000, Dimitri van Heesch wrote:

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.

On 2013-05-27 19:48:22 +0000, Sylwester Arabas wrote:

Thanks for looking at it and for the explanation. I've renamed the issue to "support @cite within brief description (was: ...)".

Sylwester

On 2013-05-30 19:33:46 +0000, Dimitri van Heesch wrote:

Issue with @cite inside brief should be fixed in the next GIT update.

*** This bug has been marked as a duplicate of bug 684324 ***

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.