Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing @return parsing ? #9

Closed
NicolasGach opened this issue Nov 23, 2020 · 2 comments
Closed

Missing @return parsing ? #9

NicolasGach opened this issue Nov 23, 2020 · 2 comments

Comments

@NicolasGach
Copy link
Contributor

NicolasGach commented Nov 23, 2020

Hello Cesar,
First of all thanks for sharing this plugin, what a very useful work ! I've stumbled upon what I believe to be an issue with the parsing of @return statements in the javadoc like structure. Here's the simple dummy class I wrote, and below the generate markdown. No configuration file is used. Happy to help solve this if you'd like, although I'm not sure where to start in the implementation you propose.

public class dummyTest {
    /**
     * @description Some description for the class.
     * @param myParam Some input parameter
     * @return a return value
     */
    public String dummyMethod(Integer myParam) {
        return '';
    }
}

And the generated markdown :

---
layout: default
---
# dummyTest class
---
## Methods
### `dummyMethod(Integer myParam)` → `String`

Some description for the class.

#### Parameters
|Param|Description|
|-----|-----------|
|`myParam` |  Some input parameter |

---

Thanks again for your work, I can definitely see this plugin gaining a lot of traction and interest seeing the void around proper Javadoc like support for Apex !

@cesarParra
Copy link
Owner

Thanks @NicolasGach . This is definitely a gap. I've merged your PR and will be releasing a new version soon. Thanks a lot!

@cesarParra
Copy link
Owner

v1.11.0 has been released with the fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants