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

WIP: Rework documentation parser #1259

Merged

Conversation

MangelMaxime
Copy link
Contributor

Related to ionide/FsAutoComplete#446

I am creating this PR because I am starting the integration with the new FSAC version. For now, it's using the new parser for the tooltip and info panel.

People can try to build it locally and see if the parser is working as expected.

@MangelMaxime
Copy link
Contributor Author

This PR also change the "F#: Generate generation" output format:

Before

/// **Description**
///
/// **Parameters**
///   * `url` - parameter of type `'a`
///   * `data` - parameter of type `'b`
///   * `decoder` - parameter of type `'c`
///   * `properties` - parameter of type `'d`
///
/// **Output Type**
///   * `string`
///
/// **Exceptions**
///
let test2 url data decoder properties = ""

After

/// <summary>
/// 
/// </summary>
/// <param name="url"></param>
/// <param name="data"></param>
/// <param name="decoder"></param>
/// <param name="properties"></param>
/// <returns></returns> 
let test2 url data decoder properties = ""

There is a bit of information loss, but it's because of the feature supported by doc comment tags.

@Krzysztof-Cieslak Krzysztof-Cieslak merged commit 1dccf71 into ionide:master Mar 10, 2020
@MangelMaxime MangelMaxime deleted the feature/unifiy_doc_parser branch August 17, 2022 08:10
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