After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 680697 - Adjacent xrefitems will not be joined
Adjacent xrefitems will not be joined
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: documentation
1.8.1.2
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2012-07-27 11:00 UTC by Philipp Moeller
Modified: 2012-08-11 13:18 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
A patch for joining adjacent xrefitems (302 bytes, patch)
2012-07-27 11:00 UTC, Philipp Moeller
none Details | Review

Description Philipp Moeller 2012-07-27 11:00:17 UTC
Created attachment 219732 [details] [review]
A patch for joining adjacent xrefitems

Given this

/// A superb struct.
/// Will be joined together:
/// \todo Yada
/// \todo Bar
///
/// Will not be joined together
/// \xrefitem MyRef "MyRef" "MyRef" Yada
/// \xrefitem MyRef "MyRef" "MyRef" Bar
struct Foo
{};

The custom xrefitems will not be joined into a single paragraph.

I think this is caused by `handleXRefItem` in commentscan.l not
setting the new XRefKind correctly. The attached diff fixes this
problem and xrefitems end up being joined into a single paragraph.

If the original behavior (don't join) was intended as the default
behavior, I think this should be added as a configuration
switch. There are a few mails requesting something like this and it is
odd that xrefitem behaves different from `bug` and `todo` even though
it is intended as a generalization.
Comment 1 Dimitri van Heesch 2012-07-27 12:01:34 UTC
Hi Philipp,

Thanks for looking into this.
\xrefitem should indeed behave as a generalization of bug and todo.
I'll include the patch in the next subversion update.
Comment 2 Dimitri van Heesch 2012-08-11 13:18:23 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.2. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.