home *** CD-ROM | disk | FTP | other *** search
/ Chip 2005 February / CMCD0205.ISO / Software / Freeware / Programare / Sharp / SharpDevelop_1.0.3.1761_Setup.exe / NDoc.VisualStudio.xml < prev    next >
Encoding:
Extensible Markup Language  |  2004-12-20  |  7.3 KB  |  145 lines
  1. <?xml version="1.0"?>
  2. <doc>
  3.     <assembly>
  4.         <name>NDoc.VisualStudio</name>
  5.     </assembly>
  6.     <members>
  7.         <member name="T:NDoc.VisualStudio.Project">
  8.             <summary>
  9.             Represents a Visual Studio c# project file.
  10.             </summary>
  11.         </member>
  12.         <member name="M:NDoc.VisualStudio.Project.Read(System.String)">
  13.             <summary>Reads the project file from the specified path.</summary>
  14.             <param name="path">The path to the project file.</param>
  15.         </member>
  16.         <member name="M:NDoc.VisualStudio.Project.GetConfiguration(System.String)">
  17.             <summary>Gets the configuration with the specified name.</summary>
  18.             <param name="configName">A valid configuration name, usually "Debug" or "Release".</param>
  19.             <returns>A ProjectConfig object.</returns>
  20.         </member>
  21.         <member name="M:NDoc.VisualStudio.Project.GetRelativeOutputPathForConfiguration(System.String)">
  22.             <summary>Gets the relative path (from the solution directory) to the
  23.             assembly this project generates.</summary>
  24.             <param name="configName">A valid configuration name, usually "Debug" or "Release".</param>
  25.         </member>
  26.         <member name="M:NDoc.VisualStudio.Project.GetRelativePathToDocumentationFile(System.String)">
  27.             <summary>Gets the relative path (from the solution directory) to the
  28.             XML documentation this project generates.</summary>
  29.             <param name="configName">A valid configuration name, usually "Debug" or "Release".</param>
  30.         </member>
  31.         <member name="P:NDoc.VisualStudio.Project.Solution">
  32.             <summary>Gets the solution that contains this project.</summary>
  33.         </member>
  34.         <member name="P:NDoc.VisualStudio.Project.RelativePath">
  35.             <summary>Gets or sets the relative path (from the solution 
  36.             directory) to the project directory.</summary>
  37.         </member>
  38.         <member name="P:NDoc.VisualStudio.Project.ID">
  39.             <summary>Gets the GUID that identifies the project.</summary>
  40.         </member>
  41.         <member name="P:NDoc.VisualStudio.Project.Name">
  42.             <summary>Gets the name of the project.</summary>
  43.         </member>
  44.         <member name="P:NDoc.VisualStudio.Project.ProjectType">
  45.             <summary>Gets a string that represents the type of project.</summary>
  46.             <value>"Visual C++" or "C# Local"</value>
  47.         </member>
  48.         <member name="P:NDoc.VisualStudio.Project.AssemblyName">
  49.             <summary>Gets the name of the assembly this project generates.</summary>
  50.         </member>
  51.         <member name="P:NDoc.VisualStudio.Project.OutputType">
  52.             <summary>Gets the output type of the project.</summary>
  53.             <value>"Library", "Exe", or "WinExe"</value>
  54.         </member>
  55.         <member name="P:NDoc.VisualStudio.Project.OutputFile">
  56.             <summary>Gets the filename of the generated assembly.</summary>
  57.         </member>
  58.         <member name="P:NDoc.VisualStudio.Project.RootNamespace">
  59.             <summary>Gets the default namespace for the project.</summary>
  60.         </member>
  61.         <member name="T:NDoc.VisualStudio.ProjectConfig">
  62.             <summary>
  63.             ProjectConfig settings for Visual Studio C# projects.
  64.             </summary>
  65.         </member>
  66.         <member name="P:NDoc.VisualStudio.ProjectConfig.Name">
  67.             <summary>Gets the name of the configuration.</summary>
  68.             <remarks>This is usually "Debug" or "Release".</remarks>
  69.         </member>
  70.         <member name="P:NDoc.VisualStudio.ProjectConfig.OutputPath">
  71.             <summary>Gets the location of the output files (relative to the 
  72.             project directory) for this project's configuration.</summary>
  73.         </member>
  74.         <member name="P:NDoc.VisualStudio.ProjectConfig.DocumentationFile">
  75.             <summary>Gets the name of the file (relative to the project 
  76.             directory) into which documentation comments will be 
  77.             processed.</summary>
  78.         </member>
  79.         <member name="T:NDoc.VisualStudio.Solution">
  80.             <summary>
  81.             Represents a Visual Studio solution file.
  82.             </summary>
  83.             <remarks>
  84.             This class is used to read a Visual Studio solution file
  85.             </remarks>
  86.         </member>
  87.         <member name="M:NDoc.VisualStudio.Solution.#ctor(System.String)">
  88.             <summary>
  89.             Initializes a new instance of the Solution class.
  90.             </summary>
  91.             <param name="slnPath">The Visual Studio solution file to parse.</param>
  92.         </member>
  93.         <member name="M:NDoc.VisualStudio.Solution.Read(System.String)">
  94.             <summary>Reads a .sln file.</summary>
  95.             <param name="path">The path to the .sln file.</param>
  96.         </member>
  97.         <member name="M:NDoc.VisualStudio.Solution.GetProjectConfigName(System.String,System.String)">
  98.             <summary>
  99.             Returns the specified project's configuration name based for 
  100.             a specific solution configuration.
  101.             </summary>
  102.             <param name="solutionConfig">A valid configuration name for the solution.</param>
  103.             <param name="projectId">A valid project guid.</param>
  104.             <returns>The project configuration name or null.</returns>
  105.             <remarks>The null value is returned when the parameters are invalid,
  106.             or if the project is not marked to be built under the specified
  107.             solution configuration.</remarks>
  108.         </member>
  109.         <member name="M:NDoc.VisualStudio.Solution.GetConfigurations">
  110.             <summary>
  111.             Get the solution's configurations.
  112.             </summary>
  113.             <returns>A collection of configuration names.</returns>
  114.         </member>
  115.         <member name="M:NDoc.VisualStudio.Solution.GetProject(System.Guid)">
  116.             <summary>Gets the project with the specified GUID.</summary>
  117.             <param name="id">The GUID used to identify the project in the .sln file.</param>
  118.             <returns>The project.</returns>
  119.         </member>
  120.         <member name="M:NDoc.VisualStudio.Solution.GetProject(System.String)">
  121.             <summary>Gets the project with the specified name.</summary>
  122.             <param name="name">The project name.</param>
  123.             <returns>The project.</returns>
  124.         </member>
  125.         <member name="M:NDoc.VisualStudio.Solution.GetProjects">
  126.             <summary>Allows you to enumerate (using foreach) over the 
  127.             solution's projects.</summary>
  128.             <returns>An enumerable list of projects.</returns>
  129.         </member>
  130.         <member name="P:NDoc.VisualStudio.Solution.Directory">
  131.             <summary>Gets the SolutionDirectory property.</summary>
  132.             <remarks>This is the directory that contains the VS.NET
  133.             solution file.</remarks>
  134.         </member>
  135.         <member name="P:NDoc.VisualStudio.Solution.Name">
  136.             <summary>Gets the SolutionName property.</summary>
  137.             <remarks>This is the name of the VS.NET solution file
  138.             without the .sln extension.</remarks>
  139.         </member>
  140.         <member name="P:NDoc.VisualStudio.Solution.ProjectCount">
  141.             <summary>Gets a count of the number of projects in the solution</summary>
  142.         </member>
  143.     </members>
  144. </doc>
  145.