Namespace-level documentation showing up in the wrong place about breathe HOT 3 CLOSED

Hey,

Thanks again for the report. This one is a tricky one, it seems that comments above a namespace are associated with that namespace but as there is only one central representation of the namespace in the xml files then multiple comments from multiple source files are concatenated into the same "briefdescription"/"detaileddescription" pair in that xml file.

One hacky way to avoid this is to make the comment a file level comment, in which case it appears above the namespace in the breathe output but only appears for the correct file referenced by doxygenfile directive. So your example would look like:

#ifndef SOME_INCLUDE_GUARD
#define SOME_INCLUDE_GUARD

#include <secret_nuclear_launch_codes.hpp>

/** \file TheFile.hpp
    THESE ARE THE COMMENTS I'M TALKING ABOUT
  */

namespace foo {
...etc...

I'm not aware of a better solution at the moment. We could try to introduce one, possibly by having some kind of labelling mechanism to specify the original of the comment but that will clutter up your comments a little.

I haven't build your project yet, though I'm curious to as it looks like an interesting idea. I'll try to do that but I suspect if you find the equivalent of namespacefoo.xml from your example you'll see all the comment concatenated with no clear way of separating them on a per file basis. If you see something we could use please say.

Sorry not to be more helpful, I'll try to take another look at the weekend,
Michael

from breathe.

Hmmm...this sounds like a case of user-error. I should probably be using the "\file" qualifier since that's what I really mean; it sounds like breathe is doing the right thing wrt namespace comments.

I'm happy to consider this issue closed. If "\file" doesn't work, then that would be a different issue.

from breathe.

Cool, thanks for closing it!

from breathe.