-
Notifications
You must be signed in to change notification settings - Fork 130
Convert proto markdown to language-specific doc format in all languages #331
Comments
Related PRs for Python:
Per @geigerj: See also and for what Python does here. As discussed offline it would eventually be good to get a proper Markdown processor hooked up to this, like what we have internally. |
According to an internal wiki, all docs should conform to https://github.com/sirthias/pegdown (Apache licensed). Might be possible to just use it. |
As I've noted internally, I would much prefer that a lot of this work is done in protoc. Without that, all the generated Javadoc for Java protos and ditto the XML documentation for C# will end up still being done in Markdown. |
Not necessary in C#. The C# documentation processors handle markdown fine. |
@chrisdunelm: Well, sort of. docfx does, but Visual Studio doesn't (for Intellisense) - and we don't resolve all the inter-proto references etc. It would definitely be better if we could generate idiomatic XML documentation, IMO. |
OK, marking this as not done for C# again ;) |
Looks like this is fixed for Java, and most other languages (save PHP) have migrated to microgenerators. Closing as obsolete. |
The text was updated successfully, but these errors were encountered: