search

EWSoftware / SHFB

Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools.
Other
2.19k stars 369 forks source link

Unexpected error preventing compile of doc project #197

Closed michaeltagmose closed 9 years ago

michaeltagmose commented 9 years ago

Hi EW

I can`t seem to get around this one:

An unexpected error occurred trying to execute the MRefBuilder MSBuild task: System.InvalidOperationException: Hellosam.Net.Collections.ObservableDictionary`2<Invisio.Common.Dtos.FrequencyEnum,System.Double> [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj]

The library containing the ObservableDictionary called Hellosam is not mine and I would like to exempt it from documentation. I`m not getting anywhere though, since most operations requires the project to compile. What to do?

Best regards

EWSoftware commented 9 years ago

Is that the full error? It's not much to go on. If you aren't using the latest release, upgrade. That may fix the issue depending on what it is. If you're using the solution as a documentation source, add the individual projects and exclude the failing one. You may need to add it as a reference assembly in the SHFB project if it's used by the others.

michaeltagmose commented 9 years ago

Sorry for the delay. The full error looks like this:

<?xml version="1.0" encoding="utf-8"?>

Finding tools... The Sandcastle tools are located in 'C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder' Locating components in the following folder(s): C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation C:\ProgramData\EWSoftware\Sandcastle Help File Builder\Components and Plug-Ins\ C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\ Framework reflection data location: C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\Data.NETFramework Using presentation style 'VS2013' located in 'C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\PresentationStyles\VS2013' Loading and initializing plug-ins... Lightweight Website Style Version 2015.7.25.0 Copyright © 2006-2015, Eric Woodruff, All Rights Reserved ## Portions Copyright © 2014, Sam Harwell, All Rights Reserved Clearing any prior web/markdown output... Validating and copying documentation source information Source: C:\Dev\Prototypes\FittingProto\FittingPrototype.sln Found project 'C:\Dev\Prototypes\FittingProto\FittingPrototype\FittingPrototype.csproj' Found project 'C:\Dev\Prototypes\FittingProto\FittingService\FittingService.csproj' Found project 'C:\Dev\Prototypes\FittingProto\Interfaces\Interfaces.csproj' Found project 'C:\Dev\Prototypes\FittingProto\DTOs\Dtos.csproj' Parsing project files Found assembly 'C:\Dev\Prototypes\FittingProto\FittingPrototype\bin\Release\FittingPrototype.exe' Found assembly 'C:\Dev\Prototypes\FittingProto\FittingService\bin\Release\FittingManager.dll' Found assembly 'C:\Dev\Prototypes\FittingProto\Interfaces\bin\Release\Interfaces.dll' Found assembly 'C:\Dev\Prototypes\FittingProto\DTOs\bin\Release\Dtos.dll' References to include (excluding framework assemblies): AutoMapper, Version=4.0.4.0, Culture=neutral, PublicKeyToken=be96cd2c38ef1005, processorArchitecture=MSIL EntityFramework, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, processorArchitecture=MSIL EntityFramework.SqlServer, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, processorArchitecture=MSIL Hellosam.Net.Collections, Version=1.0.0.0, Culture=neutral, processorArchitecture=MSIL Microsoft.Expression.Interactions, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL Microsoft.Practices.Prism.Mvvm, Version=1.1.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL Microsoft.Practices.Prism.Mvvm.Desktop, Version=1.1.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL Microsoft.Practices.Prism.SharedInterfaces, Version=1.1.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL Microsoft.Practices.ServiceLocation, Version=1.3.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL Prism, Version=6.0.1.0, Culture=neutral, processorArchitecture=MSIL Prism.Wpf, Version=6.0.1.0, Culture=neutral, processorArchitecture=MSIL ServiceModelEx, Version=1.0.0.0, Culture=neutral, PublicKeyToken=d0f8277329bba7a0, processorArchitecture=MSIL System.Windows.Interactivity, Version=4.5.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL SHFB: Warning BE0062: No XML comments files found. The help file will not contain any member comments. Generating shared content files (en-US, English (United States))... Last step completed in 00:00:00,1397 Generating API filter for MRefBuilder... Last step completed in 00:00:00,0060 Generating reflection information... [C:\Program Files (x86)\MSBuild\14.0\bin\MSBuild.exe - GenerateRefInfo.proj] Build started 20-10-2015 09:29:28. Project "C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj" on node 1 (default targets). PrepareForBuild: Creating directory "obj\Debug". GenerateRefInfo: MRefBuilder (v2015.7.25.0) Copyright ¸ 2006-2015, Microsoft Corporation, All Rights Reserved. Portions Copyright ¸ 2006-2015, Eric Woodruff, All Rights Reserved. Loaded 4 assemblies for reflection and 64 dependency assemblies. MRefBuilder : error : An unexpected error occurred trying to execute the MRefBuilder MSBuild task: System.InvalidOperationException: Hellosam.Net.Collections.ObservableDictionary`2<Invisio.Common.Dtos.FrequencyEnum,System.Double> [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : Hellosam.Net.Collections.ObservableDictionary`2<Invisio.Common.Dtos.FrequencyEnum,System.Double>.CopyTo(System.Collections.Generic.KeyValuePair`2<Invisio.Common.Dtos.FrequencyEnum,System.Double>[],System.Int32) [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : No members in the template matched the parameters of the specialization. This is not possible but apparently it happened. [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : at Microsoft.Ddue.Tools.Reflection.ReflectionUtilities.GetTemplateMember(Member member) [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : at Microsoft.Ddue.Tools.ManagedReflectionWriter.WriteTypeElements(TypeNode type) [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : at Microsoft.Ddue.Tools.ManagedReflectionWriter.WriteType(TypeNode type) [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : at Microsoft.Ddue.Tools.ManagedReflectionWriter.VisitType(TypeNode type) [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : at Microsoft.Ddue.Tools.Reflection.ApiVisitor.VisitTypes(TypeNodeList types) [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : at Microsoft.Ddue.Tools.Reflection.ApiVisitor.VisitNamespace(Namespace space) [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : at Microsoft.Ddue.Tools.ManagedReflectionWriter.VisitNamespace(Namespace space) [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : at Microsoft.Ddue.Tools.Reflection.ApiVisitor.VisitNamespaces(NamespaceList spaces) [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : at Microsoft.Ddue.Tools.ManagedReflectionWriter.VisitNamespaces(NamespaceList spaces) [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : at Microsoft.Ddue.Tools.Reflection.ApiVisitor.VisitApis() [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : at Microsoft.Ddue.Tools.MRefBuilderCore.Main(String[] args) [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] MRefBuilder : error : at Microsoft.Ddue.Tools.MSBuild.MRefBuilder.Execute() [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj] Done Building Project "C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\GenerateRefInfo.proj" (default targets) -- FAILED. Build FAILED. Time Elapsed 00:00:00.81 Last step completed in 00:00:00,9751 SHFB: Error BE0043: Unexpected error detected in last build step. See build log for details. at SandcastleBuilder.Utils.BuildEngine.TaskRunner.Run(String processFilename, String targetFile, String arguments) at SandcastleBuilder.Utils.BuildEngine.TaskRunner.RunProject(String projectFile, Boolean minimalOutput) at SandcastleBuilder.Utils.BuildEngine.BuildProcess.Build()
EWSoftware commented 9 years ago

Upgrade to the latest release (2015.10.10.0) and it should resolve that issue.

michaeltagmose commented 9 years ago

The issue seems to be solved, but this thing annoys me: BuildAssembler : warning : ShowMissingComponent: [T:Invisio.Client.App] Missing

documentation [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\BuildReferenceTopics.proj] BuildAssembler : warning : ShowMissingComponent: [M:Invisio.Client.App.InitializeComponent] Missing

documentation [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\BuildReferenceTopics.proj] BuildAssembler : warning : ShowMissingComponent: [M:Invisio.Client.App.Main] Missing

documentation [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\BuildReferenceTopics.proj] BuildAssembler : warning : ShowMissingComponent: [T:Invisio.Client.Bootstrapper] Missing

documentation [C:\Dev\Prototypes\FittingProto\Doc\FittingProto Documentation\Help\Working\BuildReferenceTopics.proj]

I get a lot of these messages, and said component DO have summary entries. How do I get rid of all these warnings?

EWSoftware commented 9 years ago

Make sure the XML comments files are actually being generated when the assemblies are being built and that they are up to date based on the configuration you are using (Debug vs Release for example). The build log will tell you what XML comments files it found, which ones it didn't, and where they are located. You can check them to see if the noted comment elements do exist in the files it used for the build.