missing function parameters about breathe HOT 12 CLOSED

Hi,

Sorry to hear that. There is no option to set, they should just be coming through.

Have you tried doing a "make html" in the "testsuite" that comes with breathe? Are they missing there or with other code? Maybe we can isolate what is going on.

I'm currently using linux, python2.5, doxygen1.7.2, and sphinx 1.0.4, so almost the same!

Michael

from breathe.

The output of the testsuite look OK to me, though I get some errors:

mkdir -p build/html build/doctrees
sphinx-build -b html -P -a -d build/doctrees source build/html
Running Sphinx v1.0.4
loading pickled environment... not yet created
building [html]: all source files
updating environment: 14 added, 0 changed, 0 removed
Failed to register id: project19group__group1_1ga24f647174760cac13d2624b5ad74b00c. It is probably a duplicate.
Failed to register id: project19group__group1_1ga053929c0809a5f56f7548fd7d9968f31. It is probably a duplicate.
Failed to register id: project19group__group1_1gadbf675591ff057ec48ce35b0d5cdf755. It is probably a duplicate.
reading sources... [100%] typedef
/Volumes/DATA/Users/dechaume/Codes/sphinx/breathe/testsuite/source/doxygen.rst:3: (SEVERE/4) Duplicate ID: "project19group__group1_1ga24f647174760cac13d2624b5ad74b00c".

/Volumes/DATA/Users/dechaume/Codes/sphinx/breathe/testsuite/source/doxygen.rst:3: (WARNING/2) Duplicate explicit target name: "project19group__group1_1ga24f647174760cac13d2624b5ad74b00c".

/Volumes/DATA/Users/dechaume/Codes/sphinx/breathe/testsuite/source/doxygen.rst:3: (SEVERE/4) Duplicate ID: "project19group__group1_1ga053929c0809a5f56f7548fd7d9968f31".

/Volumes/DATA/Users/dechaume/Codes/sphinx/breathe/testsuite/source/doxygen.rst:3: (WARNING/2) Duplicate explicit target name: "project19group__group1_1ga053929c0809a5f56f7548fd7d9968f31".

/Volumes/DATA/Users/dechaume/Codes/sphinx/breathe/testsuite/source/doxygen.rst:3: (SEVERE/4) Duplicate ID: "project19group__group1_1gadbf675591ff057ec48ce35b0d5cdf755".

/Volumes/DATA/Users/dechaume/Codes/sphinx/breathe/testsuite/source/doxygen.rst:3: (WARNING/2) Duplicate explicit target name: "project19group__group1_1gadbf675591ff057ec48ce35b0d5cdf755".

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] typedef
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 6 warnings.

Build finished. The HTML pages are in build/html.

With my class, when I generate html with doxygen, the parameters are displayed. :-/

Where should I look to see what's happening?

from breathe.

Hi,
The errors in the testsuite are unfortunately expected. I've just gotten used to them and never quite got around to really figuring them out. They don't seem to obviously affect the output, though it would be clearly worth investigating!

As for your problem, could you possibly try to make a simple example that displays the issue and send me the files? I'm not sure if the source code you're working on can be shared but maybe it would be possible to put something together?

If you're familiar enough with git and github then please fork the repository and add the code to the examples and I'll pull it in and try to debug. If you're not so comfortable with that, then I can probably just give you my email address and you could send me a tarball/zip archive of the files.

Would that be ok? If not, and you're comfortable with Python, I could try to talk you through debugging it but it is a little tricky over the internet!

Cheers,
Michael

from breathe.

Hi,

I found the problem: inlined doxygen string!

See the following example.

class Test
{
public:
/** A member function.
*

• Details about member function
  *
• \exception std::out_of_range parameter is out of range.
• @return a character pointer.
  */
  const char *member(char c, ///< c a character.
  int n) ///< n an integer.

throw(std::out_of_range);
};

Thanks.
Antoine.

from breathe.

Cool, thank you for finding it. I'll try to reproduce and fix in Breathe as necessary.

Cheers,
Michael

from breathe.

Hi Michael,

have you been able to reproduce it?

Cheers,
Antoine.

from breathe.

Hi Antoine,

Sorry for the lack of information. I've just started looking at it now. In my tests, I get the function parameters displayed but no documentation for them. Is that what you see? I was under the impression you didn't even see the parameters themselves.

I've had a look, it should be possible to fix it so we the documentation, but it is not easy to do it well. I'm about halfway through a fix I think, so hopefully we'll have something in the next couple of days.

Thank you for your patience and for prompting me!
Michael

from breathe.

Yes, the function parameters are displayed without documentation, I'm sorry for the misleading report.
Thanks for looking at it.

from breathe.

Hi Antoine,

I've push a change that should add some support for inline parameters. The trouble at the moment is that I find it hard to programmatically figure out where to insert the parameter list into the description. So currently it goes at the top of the detailed description section, which is less than ideal, but hopefully is enough for you to test for now.

Cheers,
Michael

from breathe.

Hi MIchael,

I have the same behavior, it's better than no parameter description though :-)

I don't know why but the description is not displayed on the same line as the parameter name, the '-' sign is on the same line but the remaining is on a next line.

Antoine.

from breathe.

Hi,

Yeah, this is awkward. Doxygen lists the descriptions as "para" objects which are converted to

I do this as it is currently too hard to figure out when we're dealing with situations where it is not completely ideal to do this. Most of the time it is a reasonable behaviour.

To help you can add the follow css to a stylesheet:

/* -- breathe specific styles ----------------------------------------------- */

/* So enum value descriptions are displayed inline to the item */
.breatheenumvalues li tt + p {
    display: inline;
}

/* So parameter descriptions are displayed inline to the item */
.breatheparameterlist li tt + p {
    display: inline;
}

This finds parameter lists from breathe and inlines the first

tag for every list item. Should help.

Breathe actually attempts to include a stylesheet called "breathe.css" by default which is designed to have this in it. So if you put this code in source/_static/breathe.css then it should work.

Sorry that this isn't properly documented yet.

Also, with regards to whether or not those descriptions can appear inline with the parameters, it should be possible but it is not high on the list at the moment. Sorry! Happy to advise if you want to look at fixing it yourself.

Cheers,
Michael

from breathe.

Closing as this is as resolved as it is likely to be. Please reopen if there are new issues/ideas.

from breathe.