Add xml documentation to a public method

Kapil Borle · daviwil · commit 7061ae2390b9 · 2017-06-05T06:30:50.000-07:00
diff --git a/src/PowerShellEditorServices/Language/AstOperations.cs b/src/PowerShellEditorServices/Language/AstOperations.cs
@@ -261,6 +261,11 @@ static public IEnumerable<SymbolReference> FindSymbolsInDocument(Ast scriptAst,
             return symbolReferences;
         }
 
+        /// <summary>
+        /// Checks if a given ast represents the root node of a *.psd1 file.
+        /// </summary>
+        /// <param name="scriptAst">The abstract syntax tree of the given script</param>
+        /// <returns>true if the AST represts a *.psd1 file, otherwise false</returns>
         static public bool IsPowerShellDataFileAst(Ast ast)
         {
             // sometimes we don't have reliable access to the filename

Original file line number	Diff line number	Diff line change
`@@ -261,6 +261,11 @@ static public IEnumerable<SymbolReference> FindSymbolsInDocument(Ast scriptAst,`
`261`	`261`	`return symbolReferences;`
`262`	`262`	`}`
`263`	`263`
	`264`	`+ /// <summary>`
	`265`	`+ /// Checks if a given ast represents the root node of a *.psd1 file.`
	`266`	`+ /// </summary>`
	`267`	`+ /// <param name="scriptAst">The abstract syntax tree of the given script</param>`
	`268`	`+ /// <returns>true if the AST represts a *.psd1 file, otherwise false</returns>`
`264`	`269`	`static public bool IsPowerShellDataFileAst(Ast ast)`
`265`	`270`	`{`
`266`	`271`	`// sometimes we don't have reliable access to the filename`