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

Incorrect Doxygen Paragraphs #1806

Open
ds5678 opened this issue Dec 12, 2023 · 1 comment
Open

Incorrect Doxygen Paragraphs #1806

ds5678 opened this issue Dec 12, 2023 · 1 comment

Comments

@ds5678
Copy link

ds5678 commented Dec 12, 2023

Brief Description

Doxygen permits word wrap for paragraphs, but CppSharp treats each line as its own paragraph.

OS: Windows

Used headers
/** Line 1
 *  Line 2
 *  Line 3
 *
 *  Line 4
 *  Line 5
 *
 *  Line 6 */
Used settings
DriverOptions options = driver.Options;
options.GeneratorKind = GeneratorKind.CSharp;
Expected
/// <summary>Line 1 Line 2 Line 3</summary>
/// <remarks>
/// <para>Line 4 Line 5</para>
/// <para>Line 6</para>
/// </remarks>

or

/// <summary>
/// Line 1
/// Line 2
/// Line 3
/// </summary>
/// <remarks>
/// <para>
/// Line 4
/// Line 5
/// </para>
/// <para>Line 6</para>
/// </remarks>
Actual
/// <summary>
/// <para>Line 1</para>
/// <para>Line 2</para>
/// <para>Line 3</para>
/// </summary>
/// <remarks>
/// <para>Line 4</para>
/// <para>Line 5</para>
/// <para>Line 6</para>
/// </remarks>
@tritao
Copy link
Collaborator

tritao commented Dec 12, 2023

The comment printing code is here: https://github.com/mono/CppSharp/blob/main/src/Generator/Generators/CSharp/CSharpCommentPrinter.cs

It would be insightful to check first how the data ends up in the AST first (as returned by Clang) and then how it gets transformed in that file.

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

No branches or pull requests

2 participants