Skip to content

Possible incorrect generation of returns documentation #3

@jackt-swf

Description

@jackt-swf

Hello and thank you for this awesome repo, it's made generating FFI's much easier for me.

I am having an issue when transforming doxygen's \return.

If given this doxygen comment:
\\return DPFPDD_SUCCESS: Library was initialized;\n\\return DPFPDD_E_FAILURE: Failed to initialize library.

Which looks like this:

Returns
    DPFPDD_SUCCESS: Library was initialized;
    DPFPDD_E_FAILURE: Failed to initialize library.

doxgen-bindgen::transform outputs:
# Returns\n\nDPFPDD_SUCCESS: Library was initialized;\nDPFPDD_E_FAILURE: Failed to initialize library.

Which looks like this:

Returns
DPFPDD_SUCCESS: Library was initialized; DPFPDD_E_FAILURE: Failed to initialize library.

What I am wonder is if its possible to format multiple \returns similar to how \params are formatted, as a list, like such:

Returns
DPFPDD_SUCCESS - Library was initialized;
DPFPDD_E_FAILURE - Failed to initialize library.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions