Skip to content
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

Line doc comments handled wrong (DMD issue?) #58

Closed
Abscissa opened this issue Aug 30, 2014 · 5 comments
Closed

Line doc comments handled wrong (DMD issue?) #58

Abscissa opened this issue Aug 30, 2014 · 5 comments

Comments

@Abscissa
Copy link

I'm not sure if this is an issue with ddox or dmd, but doc comments like this are handled wrong, which is a bit of a pain:

/// This function is here to aid in making your
/// software do cool stuff.
void foo() {}

ddox splits that into two ugly paragraphs:

This function is here to aid in making your

software do cool stuff.

Instead of:

This function is here to aid in making your software do cool stuff.
@s-ludwig
Copy link
Member

s-ludwig commented Apr 5, 2015

Indeed is an issue in DMD, it gets output as "This function is here to aid in making your\n\nsoftware do cool stuff.\n" in the JSON document.

@s-ludwig
Copy link
Member

s-ludwig commented Apr 5, 2015

@s-ludwig
Copy link
Member

s-ludwig commented Apr 7, 2015

@Abscissa can you have a look at the DMD issue? I'm in favor of your proposed behavior, but the bug report could use some more voices.

@Abscissa
Copy link
Author

DMD Pull Request: dlang/dmd#4745

@s-ludwig
Copy link
Member

Glad that this got through at last.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants