pseudomuto / protoc-gen-doc

Documentation generator plugin for Google Protocol Buffers
MIT License
2.64k stars 464 forks source link

Documentation for Map Entry #364

Open HollaWaldfee opened 6 years ago

HollaWaldfee commented 6 years ago

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:

/**

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?

charlie430 commented 4 years ago

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

tilakraj9560 commented 3 years ago

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

nahidakbar commented 2 years ago

same question

jackstar12 commented 7 months ago

same problem here

charlie430 commented 7 months ago

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