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 C++11 unified initializer (Origin: bugzilla #688647) #4959

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.2 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2012-11-19 14:45:10 +0000, Keith Chan wrote:

No documentation is generated for code following the use of a C++11 unified initializer:

/**

  • foo
    */
    class foo {
    int x_;

public:
foo() : x_{42} {}

/**
 * f
 */
void f();

};

No documentation is generated for f(). However, if you use normal parentheses for initializing:

/**

  • foo
    */
    class foo {
    int x_;

public:
foo() : x_(42) {}

/**
 * f
 */
void f();

};

Documentation for f() is generated.

On 2012-11-19 23:05:06 +0000, Keith Chan wrote:

Created attachment 229414
Doxyfile

On 2012-11-23 18:10:33 +0000, Kevin McBride wrote:

Created attachment 229737
Slightly Modified Sample

I find that the class gets defined, but function void f() is not defined in Doxygen when the newer C++11 syntax is used.

On 2012-11-25 14:03:00 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2012-12-26 16:09:01 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.3. 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.

On 2014-12-11 11:23:23 +0000, Freddie Chopin wrote:

I'm reporting it here - if necessary I can open a new bug, so please tell me if that would be preferable.

I'm using doxygen 1.8.8 on Arch Linux, so the bug 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 versions:

--->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 2014-12-11 11:25:42 +0000, Freddie Chopin wrote:

Created attachment 292523
New test case - nested initializers

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

I've opened a new bug # 742095, sorry for the noise in old thread.

@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