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

Handle <parameter> etc for XML comments #295

Closed
zealisland opened this issue Apr 17, 2015 · 2 comments
Closed

Handle <parameter> etc for XML comments #295

zealisland opened this issue Apr 17, 2015 · 2 comments

Comments

@zealisland
Copy link

In http://tpetricek.github.io/FSharp.Formatting/metadata.html, it mentions that

Note that currently our code is not handling and ` tags, this is not so much of a problem given that given that FSharp.Formatting infers the signature via reflection.

Just want to check whether this is on the roadmap? If so, when will etc be supported?

Thanks!

@tpetricek
Copy link
Member

We'd be happy to add support for this.

If you're interested in contributing, this is something that can be handled in the readXmlComment function here in the source code. I think that all that needs to be done is to change it to recognisze the <parameter> tag and turn it into <ul> HTML element with <li> elements for all parameters (and append this to the generated string). So it should be a nice issue for a new contributor :-).

(There is also a project csharpSupport in tests folder, so this is a place where you can add a sample documented method, which can then be processed and checked by the tests.)

@matthid
Copy link
Member

matthid commented Dec 29, 2015

I think this has been merged an released with #331.

@matthid matthid closed this as completed Dec 29, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants