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

[Bug] Angle bracket escaping is fixed for blocks, but not inline code #8629

Closed
jskeet opened this issue Apr 11, 2023 · 0 comments · Fixed by #8630
Closed

[Bug] Angle bracket escaping is fixed for blocks, but not inline code #8629

jskeet opened this issue Apr 11, 2023 · 0 comments · Fixed by #8630
Labels
dotnet Generate .NET API reference docs

Comments

@jskeet
Copy link

jskeet commented Apr 11, 2023

Describe the bug

#2723 was marked as completed via #8596, but I believe that only fixes it for blocks.

To Reproduce
Steps to reproduce the behavior:

In a new project use this code:

namespace Escaping;

/// <summary>Class summary</summary>
public class Library
{
    /// <summary>Inline `&lt;angle brackets&gt;`.</summary>
    public void Method1()
    {
    }

    /// <summary>Block
    ///
    ///     Line before
    ///     &lt;angle brackets&gt;
    ///     Line after
    /// </summary>
    public void Method2()
    {
    }
}

... and this docfx config:

{
  "metadata": [{
    "src": [{ "files": ["*.csproj"]}],
    "dest": "api",
  }],
  "build": {
    "content": [{ "files": ["api/**.yml", "api/index.md"] }],
    "dest": "_site",
    "template": ["default"],
  }
}

Build and serve the file.

Expected behavior

<angle brackets> in both block and inline documentation.

Instead:

Working block, failing inline

Context (please complete the following information):

  • OS: Windows
  • Docfx version: 2.65.2
  • .NET version: SDK 6.0.407
@jskeet jskeet added bug dotnet Generate .NET API reference docs labels Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dotnet Generate .NET API reference docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant