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

Missing documentation after nested C++11 unified initializer (Origin: bugzilla #742095) #5697

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 major in component general for ---
Reported in version 1.8.8 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2014-12-29 17:17:07 +0000, Freddie Chopin wrote:

Created attachment 293449
test case - nested initializers

This is related to bug # 688647 - I first reported it there ( https://bugzilla.gnome.org/show_bug.cgi?id=688647#c5 ), but it's best to open a new one...

I'm using doxygen 1.8.8 on Arch Linux, so bug # 688647 is supposed to be fixed, but I'm experiencing the same thing as the one reported by first post. I'll attach a test-case (one header from a project and Doxyfile) that demonstrates this.

Shorter version:

--->8--->8--->8--->8--->8--->8---

template
class FifoQueue
{
public:

...

/**
 * \brief FifoQueue's constructor
 */

FifoQueue(Storage* const storage, const size_t maxElements) :
        fifoQueueBase_{storage, maxElements,

scheduler::FifoQueueBase::TypeTag{}}
{

}

/**
 * \brief Pops the oldest (first) element from the queue.
 */

int pop(T& value)
{
    return fifoQueueBase_.pop(value);
}

...

--->8--->8--->8--->8--->8--->8---

No documentation is generated after the constructor. If I replace this:

fifoQueueBase_{storage, maxElements, scheduler::FifoQueueBase::TypeTag{}}

with this:

fifoQueueBase_(storage, maxElements, scheduler::FifoQueueBase::TypeTag{})

then everything is fine.

If I replace the same line with this:

fifoQueueBase_{storage, maxElements}

or this:

fifoQueueBase_{storage, maxElements, scheduler::FifoQueueBase::TypeTag}

it also works.

This is not related to bug # 721462 - if I put anything in the TypeTag
initializer, it still doesn't work.

So it seems that doxygen handles the new initializer syntax of C++11 only when
there is no nesting, but doesn't like the idea of one initializer embedded in
another initializer.

On 2015-02-23 19:58:57 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next GIT update.

On 2015-06-27 19:01:54 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.10. 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 (preferably in the form of a self-contained example).

@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