Open aSapien opened 4 years ago
@pseudomuto - can you assist? I find it really precious
Any update?
Would be a great feature if custom options would be considered.
https://developers.google.com/protocol-buffers/docs/proto#customoptions lists some usages on messages, fields, enums, services etc
Agreed. This would be highly valuable for a number of scenarios.
I'm fairly swamped atm. Anyone interested in giving this a go? I think we'd need to add the feature to https://github.com/pseudomuto/protokit and then update the rendering code here to print out the custom option details.
I'm seeing some code related to options in the HTML template. what is the overall status of Field Options support in protoc-gen-doc ? is it supported only for subset as described above, or there is support but it's limited to HTML ?
@pseudomuto can you give us an update on this please? This seems like a very important and useful feature.
Really looking forward to having this feature, bumping this thread again..
Hi, is there a plan to support custom, user-defined, options?
I'm willing to work on a PR if I can get some guidance and feedback.
Problem:
Custom options usages are missing from the generated descriptors:
Steps to reproduce:
service.proto
extension.proto
protocc --doc_out=. --doc_opt=json,service.json service.proto
will produce the following result (scalarValueTypes
ommited):Notice that
a_field_option
is completely missing from the result anda_method_option
is only present as a definition, but not in usage.service.json
Ideally, I would like to see the options in the generated result like this:
Any assistance on how to accomplish this and possible solutions discussions are highly appreciated.
Thanks!