peasoupio / inv

Intertwined network valuables

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Include "Groovydoc comments'" inside markdown

opened this issue · comments

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.