What is the right way to document a one liner proc?
I tried:
proc createMap(this:VS):ptr VSMap = this.vsapi.createMap()
## Creates a new property map. It must be deallocated later with freeMap(). proc createMap(this:VS):ptr VSMap = this.vsapi.createMap() ## \
## Creates a new property map. It must be deallocated later with freeMap().:)
Well its not 1 line any more? I would just make it 3 lines :)
proc createMap(this: VS):ptr VSMap =
## Creates a new property map. It must be deallocated later with freeMap().
this.vsapi.createMap()
I think this is an important special case that nim doc should handle, so that these 2 cases work:
proc fun1*() = discard ## doc comment for `fun1`
proc fun2*() = discard
## doc comment for `fun2`