-
Notifications
You must be signed in to change notification settings - Fork 468
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Multi-line comment bug with markdown output format #274
Comments
make sure you have space in .proto, if you want it in separate line , you need to something like this /**
|
@sumancholleti This workaround is not practical as it impairs the readability of documentation comments in the .proto file. |
I've just played around with v0.1.0-rc and the problem still exists. The parser should work similar to documentation generators such as
Only two line breaks, i.e. an additional blank line should cause a line break in the output format, imho. I've not tested it with other output formats. Sadly the current behavior makes the tool completely unusable for me, since I have to deal with a lot of documentation. |
For me its even worse. The breakline is not being handled in markdown tables: In both ways, the generated table is incorrect, I can't have a new line between my documentation text. @pseudomuto may you give a look? Issue since 2017 haha I will try to check if I can fix but I don't know when I will available. |
You can replace all new lines in you template with html line breaks
|
I think @lucasoares's solution is the right one, and it'd be great if their PR could get merged. Only double newlines should be converted to |
Hi,
I have built
protoc-gen-doc
from source on OSX (10.11.6) (from master, commit 97718ab) following the given steps. HTML output seems correct but markdown output has a bug with mulit-line comments where the last word on one line is concatenated to the first word on the next line. Here is a minimal example:test.proto
After running
The file
test.md
is as follows - the important thing is the appearance ofSomelongdescription
with no spaces between the words.The text was updated successfully, but these errors were encountered: