Commit ID afe5bf7f1f26fdcf63bdb8c46b5d7f7bd9131fc1
|Contributor:||Michael Jones||Files Modified:||6|
|Date:||24-November-2010 at 19:21||Lines Added:||133|
|Repository:||git://github.com/michaeljones/breathe.git master||Lines Removed:||2|
|Commit Comment:||Support for inline parameter documentation
Breathe was previously ignoring documentation for parameters that
appeared like this:
const char *member(char c, ///< c a character.
int n) ///< n an integer.
Unfortunately, doxygen does not place that information in the same place
of the xml file as it does for non-inline parameter descriptions.
So when parsing, we build up our own parameter list as we come across
these inline parameters. Then when we get to the detaileddescription
section we attempt to insert our parameter list into the
detaildescription object so it will be rendered as normal.
The insertion is a pain. First we check if there already is a list, in
which case the user has used both inline and non-inline descriptions. We
don't handle this case and just bail.
If we don't find a list, we check the contents of all the <para> nodes
in the detaildescription and if one of their contents are only text
nodes and they are all whitespace then we attempt to insert the list
before that point.
The assumption is that if the contents member of a para node is all
whitespace then it must contain some other nodes like parameter list and
so this is a reasonable place to put our list. The parameter list is
generally first in the detailed description after the text of the
description. This could fail in any number of ways, but we'll live with
it for the moment.
|File||Language||Code Added||Code Removed||Comments Added||Comment Removed||Blanks Added||Blanks Removed|
|examples/specific/inline.cfg||No source code was detected in this file.|
|testsuite/source/inline.rst||No source code was detected in this file.|
|testsuite/source/testpages.rst||No source code was detected in this file.|
Copyright © 2013 Black Duck Software, Inc. and its contributors, Some Rights Reserved. Unless otherwise marked, this work is licensed under a Creative Commons Attribution 3.0 Unported License . Ohloh ® and the Ohloh logo are trademarks of Black Duck Software, Inc. in the United States and/or other jurisdictions. All other trademarks are the property of their respective holders.