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

Adjacent xrefitems will not be joined (Origin: bugzilla #680697) #4824

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

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component documentation for ---
Reported in version 1.8.1.2 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2012-07-27 11:00:17 +0000, Philipp Moeller wrote:

Created attachment 219732
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.

On 2012-07-27 12:01:34 +0000, Dimitri van Heesch wrote:

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.

On 2012-08-11 13:18:23 +0000, Dimitri van Heesch wrote:

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.

@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