Autogenerate protobuf documentation #528

New issue

Open

opened 2025-12-28 17:19:46 +00:00 by sami · 1 comment

sami commented

2025-12-28 17:19:46 +00:00

Owner

Originally created by @fyrchik on GitHub (Apr 25, 2022).

It would be nice to have human-readable documentation generated from our proto files, similar to how it is done for neofs-api repo.

Originally created by @fyrchik on GitHub (Apr 25, 2022). It would be nice to have human-readable documentation generated from our proto files, similar to how it is done for `neofs-api` repo.

sami added the

documentation

feature

labels

2025-12-28 17:19:46 +00:00

sami commented

2025-12-28 17:19:46 +00:00

Author

Owner

@fyrchik commented on GitHub (May 20, 2022):

I tried https://github.com/pseudomuto/protoc-gen-doc/ but because we have a body and signature for each message the result is kinda overly verbose. So I propose to document the file RN and leave the task until proper solution is found or write our own template.

@fyrchik commented on GitHub (May 20, 2022): I tried https://github.com/pseudomuto/protoc-gen-doc/ but because we have a body and signature for each message the result is kinda overly verbose. So I propose to document the file RN and leave the task until proper solution is found or write our own template.