Return types in C++

[Shatur]

Issue description

Currently the plugin generates @returns for return_statement. But sometimes it doesn't work.

Examples

No return type:

    /**
     * @brief Cancel translation operation (if any).
     */
    void abort();

Return type present.

    /**
     * @brief Check translation progress
     *
     * @return `true` when the translation is still processing and has not finished or was aborted yet.
     */
    bool isRunning() const;

Additional notes

Doxygen understands @return and @returns. But I would suggest to go with @return, since @returns is just an alias to @return.

[danymat]

@Shatur Can you try updating the plugin and checking out ?

[Shatur]

I think you get me wrong. We shouldn't have @return for void and should have it in all other cases.

[Shatur]

Examples:

Instead of:

    /**
     * @brief 
     *
     * @return 
     */
    void test();

We should have:

    /**
     * @brief 
     */
    void test();

[danymat]

I don't quite get it:

• you don't want return when the return type is void ? (It was previously implemented though)
• what else ?

[Shatur]

you don't want return when the return type is void ? (It was previously implemented though)

Yes.
But it need it for all other return types (didn't worked before), but works now.

[danymat]

Okay so I just apply those changes ? #22 (comment)

[Shatur]

Yes, I think so :)

[danymat]

@Shatur Can you test the last changes ?

[Shatur]

It works, but now only for primitive types.
For example, this works as expected:

    /**
     * @brief Check translation progress
     *
     * @return `true` when the translation is still processing and has not finished or was aborted yet.
     */
    bool isRunning() const;

But this doesn't:

    /**
     * @brief 
     */
    QToolButton swapButton();

Should be like this:

    /**
     * @brief 
     *
     * @return 
     */
    QToolButton swapButton();

[danymat]

Hello @Shatur, can you try the fix provided ?

[Shatur]

Now everything is awesome, thank you!