Menu

#481 Failure: Key cannot be null. <member> tag in XML comment

v1.3
open
nobody
NDoc Core (101)
5
2006-11-21
2006-11-21
Gordy
No

NDoc version = 1.3.1
.NET Framework = MS 1.1
mode = GUI (haven't tried console)

NDoc fails where a <member> element appears explicitly in an XML doc comment, but with no name attribute, eg.

/// <summary>
/// Which way? enumeration
/// </summary>
/// <member>Left</member>
/// <member>Right</member>
enum TurnDirection { Left, Right };

Workaround is not to use member elements in XML comments. (In the above, I should have put summary elements inside the enum.)

Failure Details:
----------------
An error occured while trying to build the documentation.

Exception: NDoc.Core.DocumenterException
Key cannot be null.

Parameter name: key

Exception: System.ArgumentNullException
Key cannot be null.

Parameter name: key

Stack Trace:
------------
Exception: NDoc.Core.DocumenterException
at NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.Build(Project project)

at NDoc.Gui.BuildWorker.ThreadProc()

Exception: System.ArgumentNullException

Server stack trace:
at System.Collections.Hashtable.ContainsKey(Object key)

at NDoc.Core.Reflection.ExternalXmlSummaryCache.CacheSummaries(XmlTextReader reader)

at NDoc.Core.Reflection.ExternalXmlSummaryCache.AddXmlDoc(String xmlFileName)

at NDoc.Core.Reflection.ReflectionEngine.PreLoadXmlDocumentation()

at NDoc.Core.Reflection.ReflectionEngine.PreReflectionProcess()

at NDoc.Core.Reflection.ReflectionEngine.BuildXml(XmlWriter writer)

at NDoc.Core.Reflection.ReflectionEngine.MakeXmlFile(ReflectionEngineParameters rep, String xmlFile)

at System.Runtime.Remoting.Messaging.StackBuilderSink.PrivateProcessMessage(MethodBase mb, Object[] args, Object server, Int32 methodPtr, Boolean fExecuteInContext, Object[]& outArgs)

at System.Runtime.Remoting.Messaging.StackBuilderSink.SyncProcessMessage(IMessage msg, Int32 methodPtr, Boolean fExecuteInContext)

Exception rethrown at [0]:
at System.Runtime.Remoting.Proxies.RealProxy.HandleReturnMessage(IMessage reqMsg, IMessage retMsg)

at System.Runtime.Remoting.Proxies.RealProxy.PrivateInvoke(MessageData& msgData, Int32 type)

at NDoc.Core.Reflection.ReflectionEngine.MakeXmlFile(ReflectionEngineParameters rep, String xmlFile)

at NDoc.Core.Reflection.BaseReflectionDocumenter.MakeXmlFile(Project project, String fileName)

at NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.Build(Project project)

Discussion


Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.