Skip to content

Implement XmlDoc comment generation #2121

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.

Sign up for GitHub

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

Merged
KevinRansom merged 4 commits into from
Dec 29, 2016
Merged

Implement XmlDoc comment generation #2121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f794848
Add a service for XmlDocParser
dungpa Dec 28, 2016
83db0c6
Add corresponding VS service
dungpa Dec 28, 2016
f130571
Use VS workspace to retrieve correct documents
dungpa Dec 28, 2016
17d5acf
Use current snapshot to ensure source text is fresh
dungpa Dec 29, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/fsharp/FSharp.LanguageService.Compiler/FSharp.LanguageService.Compiler.fsproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,9 @@
<Compile Include="..\vs\ServiceAssemblyContent.fs">
<Link>Service/ServiceAssemblyContent.fs</Link>
</Compile>
<Compile Include="..\vs\ServiceXmlDocParser.fs">
<Link>Service/ServiceXmlDocParser.fs</Link>
</Compile>
<Compile Include="..\vs\service.fsi">
<Link>Service/service.fsi</Link>
</Compile>
Expand Down
96 changes: 3 additions & 93 deletions src/fsharp/vs/ServiceInterfaceStubGenerator.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
namespace Microsoft.FSharp.Compiler.SourceCodeServices
// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

namespace Microsoft.FSharp.Compiler.SourceCodeServices

open System
open System.Diagnostics
Expand All @@ -7,98 +9,6 @@ open Microsoft.FSharp.Compiler
open Microsoft.FSharp.Compiler.Ast
open Microsoft.FSharp.Compiler.Range
open Microsoft.FSharp.Compiler.SourceCodeServices

[<RequireQualifiedAccess>]
[<CompilationRepresentation (CompilationRepresentationFlags.ModuleSuffix)>]
module Array =
/// pass an array byref to reverse it in place
let revInPlace (array: 'T []) =
if Array.isEmpty array then () else
let arrlen, revlen = array.Length-1, array.Length/2 - 1
for idx in 0 .. revlen do
let t1 = array.[idx]
let t2 = array.[arrlen-idx]
array.[idx] <- t2
array.[arrlen-idx] <- t1

/// Async implementation of Array.map.
let mapAsync (mapping : 'T -> Async<'U>) (array : 'T[]) : Async<'U[]> =
let len = Array.length array
let result = Array.zeroCreate len

async { // Apply the mapping function to each array element.
for i in 0 .. len - 1 do
let! mappedValue = mapping array.[i]
result.[i] <- mappedValue

// Return the completed results.
return result
}

[<RequireQualifiedAccess>]
[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix)>]
module String =
open System.IO

let inline toCharArray (str: string) = str.ToCharArray()

let lowerCaseFirstChar (str: string) =
if String.IsNullOrEmpty str
|| Char.IsLower(str, 0) then str else
let strArr = toCharArray str
match Array.tryHead strArr with
| None -> str
| Some c ->
strArr.[0] <- Char.ToLower c
String (strArr)

let extractTrailingIndex (str: string) =
match str with
| null -> null, None
| _ ->
let charr = str.ToCharArray()
Array.revInPlace charr
let digits = Array.takeWhile Char.IsDigit charr
Array.revInPlace digits
String digits
|> function
| "" -> str, None
| index -> str.Substring (0, str.Length - index.Length), Some (int index)

/// Remove all trailing and leading whitespace from the string
/// return null if the string is null
let trim (value: string) = if isNull value then null else value.Trim()

/// Splits a string into substrings based on the strings in the array separators
let split options (separator: string []) (value: string) =
if isNull value then null else value.Split(separator, options)

let (|StartsWith|_|) pattern value =
if String.IsNullOrWhiteSpace value then
None
elif value.StartsWith pattern then
Some()
else None

let (|Contains|_|) pattern value =
if String.IsNullOrWhiteSpace value then
None
elif value.Contains pattern then
Some()
else None

let getLines (str: string) =
use reader = new StringReader(str)
[|
let line = ref (reader.ReadLine())
while not (isNull !line) do
yield !line
line := reader.ReadLine()
if str.EndsWith("\n") then
// last trailing space not returned
// http://stackoverflow.com/questions/19365404/stringreader-omits-trailing-linebreak
yield String.Empty
|]

[<AutoOpen>]
module internal CodeGenerationUtils =
Expand Down
Loading