[ndoc-tracker] [ ndoc-Bugs-780458 ] There are no documentable types in this project

[SourceForge.net <no...@so...>]

Bugs item #780458, was opened at 2003-07-30 15:18
Message generated for change (Tracker Item Submitted) made by Item Submitter
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=416078&aid=780458&group_id=36057

Category: NDoc Core
Group: v1.0
Status: Open
Resolution: None
Priority: 5
Submitted By: Michael Dang (mndang)
Assigned to: Nobody/Anonymous (nobody)
Summary: There are no documentable types in this project

Initial Comment:
I have a simple C# console app with a reference to the 
Interop.SourceSafeTypeLib.dll.  At this point the main 
method only calls to write a message out to the 
console.  The code is below and pretty simple.  I don't 
even call anything from VSS yet.

I am using NAnt to try and generate the MSDN style 
documentation.  The XML file gets generated but then 
NDoc tries to merge the XML file an error occurs.  See 
below error.

Could someone help me on this error?

Error:
    [mkdir] Creating directory 
C:\Projects\TestArea\SampleNant\DotNet\SampleNantBuil
dResult\bin
     [copy] Copying 1 file
     [nant] SampleNantBuildVSSTask.build test
            Buildfile: 
file:///C:/Projects/TestArea/SampleNant/DotNet/SampleN
antBuildVSSTask.build
            
            build:
                 [copy] Copying 1 file
                  [csc] Compiling 2 files to 
C:\Projects\TestArea\SampleNant\DotNet\SampleNantBuil
dResult\bin\SampleNantBuildVSS.exe
            
            generatehelp:
                 [ndoc] Initializing...
                 [ndoc] Merging XML documentation...
                 [ndoc] Error building documentation.
            
BUILD FAILED
C:\Projects\TestArea\SampleNant\DotNet\SampleNantBuil
dVSSTask.build(27,4):
      [ndoc] Error building documentation.
There are no documentable types in this project.

BUILD FAILED



Console C#Code:

using System;
using SourceSafeTypeLib;

namespace SampleNantBuildVSS
{
	/// <summary>
	/// Private class: SampleNantBuildVSSClass.  
Used to hold the console app code.
	/// </summary>
	class SampleNantBuildVSSClass
	{
		private VSSDatabaseClass VSSDB;
		public string VSSiniFilePath="";
		public string username="";
		public string pw="";

		/// <summary>
		/// The main entry point for the 
application.
		/// </summary>
		[STAThread]
		static void Main(string[] args)
		{
			//
			// TODO: Add code to start 
application here
			//
			
			Console.WriteLine("I called 
a console app!");

		}

		/// <summary>
		/// Private method OpenVSSDB to 
open a specified VSS DB.  Does not return anything.
		/// </summary>
		/// <param 
name="strVSSiniFilePath">String parameter specifying 
the VSS Sourcesafe .ini file path.</param>
		/// <param 
name="strUsername">String parameter to pass in VSS 
username.</param>
		/// <param name="strPW">String 
parameter to pass in VSS password.</param>
		private void OpenVSSDB(string 
strVSSiniFilePath, string strUsername, string strPW)
		{
			this.VSSDB = new 
VSSDatabaseClass();
			this.VSSDB.Open
(this.VSSiniFilePath, this.username, this.pw);
		}

		/// <summary>
		/// Public method to get a specific 
versioned labeled item from the VSS DB.
		/// </summary>
		/// <param name="strItem">String 
param identifying what VSS file to get.</param>
		/// <param 
name="strTargetDir">String Parameter identifying the 
VSS path where file resides.</param>
		/// <param name="strLabel">String 
param identifying which labeled version of the file to 
get.</param>
		public void GetItemfromLabel(string 
strItem, string strTargetDir, string strLabel)
		{
			VSSItem objItem = 
GetVSSItem(strItem);
			VSSItem objversionedItem 
= objItem.get_Version(strLabel);

		}
		/// <summary>
		/// Private method to get a spcific 
VSS item including its history
		/// </summary>
		/// <param name="strItem">String 
param identifying what VSS file to get.</param>
		/// <returns>a VSSItem 
Object</returns>
		private VSSItem GetVSSItem(string 
strItem)
		{
			VSSItem objItem;
			objItem = 
this.VSSDB.get_VSSItem(strItem, false);
			return objItem;
		}

	}
}


Nant Build code:

<?xml version="1.0"?>
<project name="SampleNantBuildVSS" default="test">

	<property name="SampleNantBuildVSS.dir" 
value="SampleNantBuildVSS"/>
	<target name="build">
		<copy 
file="${SampleNantBuildVSS.dir}/bin/debug/Interop.Sourc
eSafeTypeLib.dll" 
tofile="${build.dir}/bin/Interop.SourceSafeTypeLib.dll" />

		<csc target="exe" warnaserror="true" 
debug="${build.debug}" 
		
	output="${build.dir}/bin/SampleNantBuildVSS.ex
e"
		
	doc="${build.dir}/bin/SampleNantBuildVSS.xml">
			<sources 
basedir="${SampleNantBuildVSS.dir}" failonempty="true">
				<includes 
name="**/*.cs"/>
			</sources>
			<references 
basedir="${build.dir}/bin">
				<includes 
name="Interop.SourceSafeTypeLib.dll" />
			</references>
			<arg 
value="/nowarn:1591"/>
		</csc>	
	</target>

	<target name="test" depends="generatehelp">
		<exec 
program="SampleNantBuildVSS.exe" 
basedir="${build.dir}/bin"/>
	
	</target>
	
	<target name="generatehelp" depends="build">
		<ndoc>
	                <assemblies 
basedir="${build.dir}/bin">
	                    <includes 
name="SampleNantBuildVSS.exe"/>

	                </assemblies>
          
	                <documenters>
	                    <documenter name="MSDN">
	                        <property 
name="OutputDirectory" value="${build.dir}
\doc\MSDN" />
	                        <property 
name="HtmlHelpName" value="NAnt" />
	                        <property 
name="HtmlHelpCompilerFilename" value="hhc.exe" />
	                        <property 
name="IncludeFavorites" value="False" />
	                        <property name="Title" 
value="An NDoc Documented Class Library" />
	                        <property name="SplitTOCs" 
value="False" />
	                        <property name="DefaulTOC" 
value="" />
	                        <property 
name="ShowVisualBasic" value="True" />
	                        <property 
name="ShowMissingSummaries" value="True" />
	                        <property 
name="ShowMissingRemarks" value="True" />
	                        <property 
name="ShowMissingParams" value="True" />
	                        <property 
name="ShowMissingReturns" value="True" />
	                        <property 
name="ShowMissingValues" value="True" />
	                        <property 
name="DocumentInternals" value="False" />
	                        <property 
name="DocumentProtected" value="True" />
	                        <property 
name="DocumentPrivates" value="False" />
	                        <property 
name="DocumentEmptyNamespaces" value="False" />
	                        <property 
name="IncludeAssemblyVersion" value="False" />
	                        <property 
name="CopyrightText" value="" />
	                        <property 
name="CopyrightHref" value="" />
	                     </documenter>
	                </documenters> 
	            </ndoc>
		</target>

</project>

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=416078&aid=780458&group_id=36057