Coder Social home page Coder Social logo

Comments (2)

ChrisLambrou avatar ChrisLambrou commented on June 29, 2024

Hi Marko,

This is intended behaviour. For <para\> elements in XML Doc comments, the line breaks are ignored, so XmlDoc2CmdletDoc honours this. The closest that's currently available is to use multiple <para\> elements. For example, the following:

<para type="description">line 1</para>
<para type="description">line 2</para>
<para type="description">line 3</para>

would be translated into the following MAML:

<maml:description>
  <maml:para>line 1</maml:para>
  <maml:para>line 2</maml:para>
  <maml:para>line 3</maml:para>
</maml:description>

which would in turn be rendered as follows by the Get-Help cmdlet:

DESCRIPTION
    line 1

    line 2

    line 3

This might be closer to what you need, but there's a very definite blank line between paragraphs. If you really need line breaks rather than separate paragraphs, I could maybe look into supporting this using <![CDATA[]]>, but it depends entirely on how well the Get-Help cmdlet accommodates this (and my experience with it doesn't make me hopeful!). Please let me know whether or not using multiple paragraphs will satisfy your needs. Either way, I still ought to make sure that <![CDATA[]]> is correctly handled, but knowing whether or not it's causing problems right now will help me prioritise this against all the other stuff I have on my plate! 😉

from xmldoc2cmdletdoc.

ChrisLambrou avatar ChrisLambrou commented on June 29, 2024

Abandoned.

from xmldoc2cmdletdoc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.