Skip to content

doxygen 'alias' expansion incorrect #3204

@clintonstimpson

Description

@clintonstimpson

I'm not getting the expected results for python docstrings in this example:

%module mytest

%feature("doxygen:alias:examplePython") "\code{.py}"
%feature("doxygen:alias:endexamplePython") "\endcode"

/**
    A splendid function.

    @examplePython
      Splendid('world')
    @endexamplePython
 */
void Splendid(const char* str);

I'm getting this result:

def Splendid(str):
    r"""
    A splendid function.

    \code{.py}
      Splendid('world')
    ^[ndcode
    """
    return _mytest.Splendid(str)

and am expecting to get this instead:

def Splendid(str):
    r"""
    A splendid function.

    .. code-block:: python

          Splendid('world')
    """
    return _mytest.Splendid(str)

Metadata

Metadata

Assignees

No one assigned

    Labels

    DoxygenRelated to -doxygen command line option

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions