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

Return value documentation should use <list> #822

Open
RalfKoban opened this issue Mar 27, 2024 · 0 comments
Open

Return value documentation should use <list> #822

RalfKoban opened this issue Mar 27, 2024 · 0 comments

Comments

@RalfKoban
Copy link
Owner

RalfKoban commented Mar 27, 2024

It may happen that the XML documentation of a return value contains text such as following example:

/// A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero Some text here. Zero Some other text here. Greater than zero Some even other text here.

This is the content of a <list> and should therefore be changed into:

/// A value that indicates the relative order of the objects being compared.
/// The return value has these meanings:
/// <list type="table">
/// <listheader><term>Value</term><description>Meaning</description></listheader>
/// <item><term>Less than zero</term><description>Some text here.</description></item>
/// <item><term>Zero</term><description>Some other text here.</description></item>
/// <item><term>Greater than zero</term><description>Some even other text here.</description></item>
/// </list>

This allows the XML renderer to render that as a proper list:

grafik

RalfKoban added a commit that referenced this issue Apr 18, 2024
…hould better use a <list> do describe the return values and their meanings

(resolves #822)
RalfKoban added a commit that referenced this issue Apr 18, 2024
…hould better use a <list> do describe the return values and their meanings

(resolves #822)
@RalfKoban RalfKoban moved this to Next in MiKo Analyzers Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Next
Development

No branches or pull requests

1 participant