Skip to content
This repository has been archived by the owner on Jun 28, 2022. It is now read-only.

Convert proto markdown to language-specific doc format in all languages #331

Closed
7 tasks
garrettjonesgoogle opened this issue Jul 28, 2016 · 7 comments
Closed
7 tasks
Assignees
Labels
lang: go Issues specific to Go. lang: java Issues specific to Java. lang: nodejs Issues specific to JavaScript or TypeScript. lang: php Issues specific to PHP. lang: python Issues specific to Python. lang: ruby Issues specific to Ruby. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@garrettjonesgoogle
Copy link
Member

garrettjonesgoogle commented Jul 28, 2016

  • Java
  • PHP
  • Node.js
  • Ruby
  • Python
  • Go
  • C#
@bjwatson bjwatson added the priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. label Sep 15, 2016
@bjwatson
Copy link
Contributor

@bjwatson bjwatson added priority: p2 Moderately-important priority. Fix may not be included in next release. and removed priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. labels Sep 21, 2016
@garrettjonesgoogle garrettjonesgoogle added lang: nodejs Issues specific to JavaScript or TypeScript. lang: python Issues specific to Python. lang: go Issues specific to Go. lang: php Issues specific to PHP. lang: ruby Issues specific to Ruby. Lang: C# lang: java Issues specific to Java. labels Oct 4, 2016
@pongad
Copy link
Contributor

pongad commented Oct 31, 2016

According to an internal wiki, all docs should conform to https://github.com/sirthias/pegdown (Apache licensed). Might be possible to just use it.

@jskeet
Copy link
Contributor

jskeet commented Nov 3, 2016

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.

@chrisdunelm
Copy link
Contributor

Not necessary in C#. The C# documentation processors handle markdown fine.

@jskeet
Copy link
Contributor

jskeet commented Feb 20, 2017

@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.

@chrisdunelm
Copy link
Contributor

OK, marking this as not done for C# again ;)

@evaogbe evaogbe added the type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. label Aug 11, 2017
@JustinBeckwith JustinBeckwith added the 🚨 This issue needs some love. label Jun 27, 2019
@sduskis sduskis removed 🚨 This issue needs some love. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Jul 3, 2019
@miraleung
Copy link
Contributor

miraleung commented Jun 3, 2020

Looks like this is fixed for Java, and most other languages (save PHP) have migrated to microgenerators. Closing as obsolete.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lang: go Issues specific to Go. lang: java Issues specific to Java. lang: nodejs Issues specific to JavaScript or TypeScript. lang: php Issues specific to PHP. lang: python Issues specific to Python. lang: ruby Issues specific to Ruby. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

No branches or pull requests