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

Render as Markdown analyzer and code fix #18

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

sharwell
Copy link
Contributor

@sharwell sharwell commented Feb 5, 2015

Remaining tasks:

  • Executing this action twice will wrap <para> blocks inside a new <para> block. A post-conversion transformation needs to undo this nesting.

  • Executing this action will always wrap <summary> content in a <para> block. A post-conversion transformation needs to undo this if the <para> block is the only child of the <summary> block.

  • Parameter names in backticks are treated as <c>paramName</c> instead of <paramref name="paramName"/>.

  • Lines containing a top-level element from the original code get an extra space during the conversion operation. For example:

    Input:

    /// <summary>
    /// Text
    /// </summary>
    /// <remarks>
    /// Remark
    /// </remarks>

    Output (note the space before <remarks>):

    /// <summary>
    /// <para>Text</para>
    /// </summary>
    ///  <remarks>
    /// <para>Remark</para>
    /// </remarks>

image

@whoisj
Copy link

whoisj commented Sep 29, 2017

@sharwell the <para/> works wonder to place between paragraphs as well, with no need to bother "wrapping" anything. Just thought I'd point that out.

Also, using that was makes for significantly more readable documentation comments.

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

Successfully merging this pull request may close these issues.

2 participants