C# Class MonoDevelop.StyleCop.ProjectUtilities

Utility class for project related stuff.

Inheritance: IDisposable

Exibir arquivo Open project: DarkCloud14/MonoDevelop.StyleCop Class Usage Examples

Private Properties

Property	Type	Description
CreateStyleCopCodeProjects	List
Dispose	void
EnumerateFile	List
EnumerateFolder	List
GetParentProjectFile	MonoDevelop.Projects.ProjectFile
GetProjectKindOfProjectType	string
HasKnownFileExtension	bool
IsDirectory	bool
IsKnownFileExtension	bool
IsKnownProjectType	bool
ProjectUtilities	System
RetrieveAvailableStyleCopParsers	void

Public Methods

Method	Description
Dispose ( ) : void	Releases all resource used by the MonoDevelop.StyleCop.ProjectUtilities object. Call Dispose() when you are finished using the MonoDevelop.StyleCop.ProjectUtilities. The Dispose() method leaves the MonoDevelop.StyleCop.ProjectUtilities in an unusable state. After calling Dispose(), you must release all references to the MonoDevelop.StyleCop.ProjectUtilities so the garbage collector can reclaim the memory that the MonoDevelop.StyleCop.ProjectUtilities was occupying.

Private Methods

Method	Description
CreateStyleCopCodeProjects ( Dictionary fromMonoDevelopProjects ) : List	Create a list with StyleCop code project based on the MonoDevelop projects and files in fromMonoDevelopProjects.
Dispose ( bool disposing ) : void	Dispose the specified disposing.
EnumerateFile ( ProjectFile projectFile ) : List	Enumerate through all childs of the given file and return all known files (including projectFile if it's a known file type!).
EnumerateFolder ( MonoDevelop.Ide.Gui.Pads.ProjectPad.ProjectFolder projectFolder ) : List	Enumerate the given folder and return all files known by StyleCop.
GetParentProjectFile ( ProjectFile projectFile ) : ProjectFile	Get the parent project file. The parent project file is the one which doesn't depend on another file.
GetProjectKindOfProjectType ( Project project ) : string	Get the official project GUID/Type of MonoDevelops project kind.
HasKnownFileExtension ( ProjectFile projectFile ) : bool	Determines whether the file has a known file extension.
IsDirectory ( string pathToCheck ) : bool	Analyzes pathToCheck and checks if it is just a directory.
IsKnownFileExtension ( string fileExtension ) : bool	Determines whether the file extension is a known file extension.
IsKnownProjectType ( Project project ) : bool	Determines whether the project is a known project type.
ProjectUtilities ( ) : System	Initializes static members of the ProjectUtilities class.
RetrieveAvailableStyleCopParsers ( ) : void	Retrieve all available StyleCop source code parsers using the parsers configuration xml. The necessary format of parsers configuration xml can be found in StyleCop source code.

Method Details

Dispose() public method

Releases all resource used by the MonoDevelop.StyleCop.ProjectUtilities object.

Call Dispose() when you are finished using the MonoDevelop.StyleCop.ProjectUtilities. The Dispose() method leaves the MonoDevelop.StyleCop.ProjectUtilities in an unusable state. After calling Dispose(), you must release all references to the MonoDevelop.StyleCop.ProjectUtilities so the garbage collector can reclaim the memory that the MonoDevelop.StyleCop.ProjectUtilities was occupying.

public Dispose ( ) : void
return	void