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

Include "Groovydoc comments'" inside markdown #97

Open
peasoupio opened this issue May 30, 2020 · 0 comments
Open

Include "Groovydoc comments'" inside markdown #97

peasoupio opened this issue May 30, 2020 · 0 comments
Assignees
Labels
cli Related to the core engines (console client) enhancement New feature or request

Comments

@peasoupio
Copy link
Collaborator

INV provides a markdown method to write markdown-style comments. Those comments are inserted into the report.md at the end of a run.

Since INV allows the broadcast of POJO (or POGO), would it be interesting to include Groovydoc comments in the report.md?

Per example:

inv {
    broadcast $inv.MyBroadcast using {
        groovydoc true
        return { return new MyPogo() }
    }
}

/**
   My superb comment
*/
class MyPogo {
   /**
       My other tremendous comment.
   */
   void myMethod() {
       // ....
   }
}

report.md:

MyINV: undefined 

Statement(s): 1
#### 1. MyBroadcast
My superb comment.
Methods:
    [type] myMethod:  My other tremendous comment.
@peasoupio peasoupio added enhancement New feature or request cli Related to the core engines (console client) labels May 30, 2020
@peasoupio peasoupio self-assigned this May 30, 2020
@peasoupio peasoupio removed their assignment Jul 22, 2020
@benjboyer benjboyer self-assigned this Jul 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Related to the core engines (console client) enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant