aBothe / Mono-D

D Add-In for MonoDevelop
http://wiki.dlang.org/Mono-D
Other
113 stars 26 forks source link

Show only the summary in multi-paragraph documentation statements #541

Closed Jebbs closed 10 years ago

Jebbs commented 10 years ago

Currently, every part of the documentation for something is shown in the code completion popup. DDoc's documentation states that the first paragraph in a multi-paragraph documentation block is known as the summary and all other paragraphs are a part of the description.

I think the code completion popup should only show the summary portion of documentation as the rest might contain information only really necessary in the html files generated with DDoc such as a very detailed description, examples, links, etc.

aBothe commented 10 years ago

This is handled already. Could you show me an example where it's showing everything?

aBothe commented 10 years ago

https://github.com/aBothe/D_Parser/blob/master/DParser2/Completion/NodeTooltipRepresentationGen.cs#L103-L113 The only regions shown besides the symbol summary are params & returns.

Jebbs commented 10 years ago

Strange. I just installed v 2.4.5, and wanted to test this out since I am adding documentation to my library. This is one such file that exhibits the problem, but I think does the same for every file with documentation like this.

aBothe commented 10 years ago

Ah, so the main problem is that it's simply not stripping off all paragraphs except the first one. Okay.