question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documentation output missing sections, lacking formatting, lacking newlines.

See original GitHub issue

Issue Description

Documentation output for my own code is lacking sections and formatting, I’ve tried in several different (new) projects and it always only shows the summary block and never properly formats newlines. I thought this was just a long standing bug that everyone experienced, but after looking through some issues, I saw that many others seem to have much more detailed and well formatted output. Is my output the expected documentation output?

Steps to Reproduce

Create any documentation.

Expected Behavior

Something like https://github.com/OmniSharp/omnisharp-vscode/pull/1918#issuecomment-350863070

Actual Behavior

image

Logs

OmniSharp log

Post the output from Output-->OmniSharp log here

C# log

Post the output from Output-->C# here

Environment information

VSCode version: 1.48.2 C# Extension: 1.23.2

Dotnet Information .NET Core SDK (reflecting any global.json): Version: 3.1.401 Commit: 39d17847db

Runtime Environment: OS Name: Windows OS Version: 10.0.19041 OS Platform: Windows RID: win10-x64 Base Path: C:\Program Files\dotnet\sdk\3.1.401\

Host (useful for support): Version: 3.1.7 Commit: fcfdef8d6b

.NET Core SDKs installed: 3.1.102 [C:\Program Files\dotnet\sdk] 3.1.302 [C:\Program Files\dotnet\sdk] 3.1.401 [C:\Program Files\dotnet\sdk]

.NET Core runtimes installed: Microsoft.AspNetCore.App 3.1.2 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 3.1.6 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 3.1.7 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.NETCore.App 3.1.2 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 3.1.6 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 3.1.7 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.WindowsDesktop.App 3.1.2 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 3.1.6 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 3.1.7 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

To install additional .NET Core runtimes or SDKs: https://aka.ms/dotnet-download

Visual Studio Code Extensions
Extension Author Version
better-align wwm 1.1.6
csharp ms-dotnettools 1.23.2
docomment k–kato 0.1.18
errorlens usernamehw 3.2.1
gitignore codezombiech 0.6.0
graphql-for-vscode kumar-harsh 1.15.3
hexeditor ms-vscode 1.2.1
jsdoc-markdown-highlighting bierner 0.0.1
markdown-all-in-one yzhang 3.3.0
msbuild-project-tools tintoy 0.3.8
path-intellisense christian-kohler 2.2.1
powershell-preview ms-vscode 2020.7.0
rainbow-csv mechatroner 1.7.1
remote-ssh-edit ms-vscode-remote 0.51.0
selected-lines-count gurumukhi 1.4.0
sqltools mtxr 0.23.0
svg jock 1.3.9
theme-karyfoundation-themes karyfoundation 20.0.3
todo-tree Gruntfuggly 0.0.178
vscode-docker ms-azuretools 1.5.0
vscode-eslint dbaeumer 2.1.8
vscode-great-icons emmanuelbeziat 2.1.52
vscode-json5 mrmlnc 1.0.0
vscode-scss mrmlnc 0.9.0
vscode-scss-formatter sibiraj-s 2.0.2
vscode-solution-explorer fernandoescolar 0.3.11
vscode-yaml redhat 0.10.1

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:8 (1 by maintainers)

github_iconTop GitHub Comments

1reaction
gregg-miskellycommented, Sep 30, 2020

This is not my area of expertise, but I think this is “by design”. If you want line breaks, you need to use <para>. Example:

        /// <summary>
        /// Line1
        /// <para>Line2</para>
        /// </summary>
0reactions
333fredcommented, Nov 1, 2020

As mentioned, the latter behavior is the correct behavior. Omnisharp now uses roslyn’s built-in handling for quick info. In xml comments in general, if you want a newline you should use a para tag.

Read more comments on GitHub >

github_iconTop Results From Across the Web

C# IntelliSense Hints are unreadable (new lines are missing)
It seems that new lines are missing between <param> and <returns> tags. ... Documentation output missing sections, lacking formatting, ...
Read more >
Javadoc: line breaks without HTML-tags? - Stack Overflow
I'm using NetBeans 7.1.2. This way using code format option will not reformat the document. Showing doc in hints is still formatted. Update:...
Read more >
Insert a new line without \newline command - TeX
The \LaTeX{} commands are recognized here without problems. EOL (Linefeed and carriage return) are just ignored. But long lines are well formatted.
Read more >
Configuration - Doxygen Manual
Format. A configuration file is a free-form ASCII text file with a structure that is similar to that of a Makefile , with...
Read more >
LaTeX Error: There's no line here to end - Overleaf
In the above example, a line-break has been inserted with no text before it. LaTeX doesn't know what to do since it cannot...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found