protoc-gen-doc icon indicating copy to clipboard operation
protoc-gen-doc copied to clipboard

Documentation for Map Entry

Open HollaWaldfee opened this issue 6 years ago • 5 comments

I'd like to generate a documentation for proto3 files. Therefore I trying to use protoc-gen-doc. I'm using maps in some messages and I couldn't find a way to document the generated Map Entry documentation.

Example Message:

/**

  • Test */ message ResponseProtobuf { map<string, string> information = 1; //Map description }

Output Documentation:

ResponseProtobuf

Test descripstion Field Type Label Description information ResponseProtobuf.InformationEntry repeated info descripton

ResponseProtobuf.InformationEntry Field Type Label Description key string
value string

The problem is, that the ResponseProtobuf.InformationEntry is auto generated and I don't know how to generate a doc for the key and value. Is there a way to document them? Is there a user documentation?

HollaWaldfee avatar Jul 16 '18 09:07 HollaWaldfee

This question was asked almost 2 years ago. What is the status of this feature?

charlie430 avatar May 26 '20 19:05 charlie430

i have the same issue, i can see label and description but how to add the values for it?

tilakraj9560 avatar Jun 26 '21 17:06 tilakraj9560

same question

nahidakbar avatar May 07 '22 11:05 nahidakbar

same problem here

jackstar12 avatar Mar 14 '24 06:03 jackstar12

I would still love a solution to this problem. :)

charlie430 avatar Mar 14 '24 13:03 charlie430