This project is read-only.
1
Vote

ShowMissingComponent issue

description

I've encountered an issue with ShowMissingComponent.

Here's my case:
Visual Studio 2012 for Windows 8
        /// <summary>
        /// Byte List To Byte Array.
        /// </summary>
        /// <param name="inBytes">Byte List</param>
        /// <returns>Byte Array</returns>
        public static byte[] ToByteArray(IList<byte> inBytes)
        {
            return new List<byte>(inBytes).ToArray();
        }
SHFB output log:
BuildAssembler : warning : ShowMissingComponent: [M:WindowsRuntimeComponent.ByteUtil.ToByteArray(Windows.Foundation.Collections.IVector{System.Byte})] Missing <summary> documentation [C:\Users\k\Documents\Help\Working\BuildReferenceTopics.proj]
BuildAssembler : warning : ShowMissingComponent: [M:WindowsRuntimeComponent.ByteUtil.ToByteArray(Windows.Foundation.Collections.IVector{System.Byte})] Missing <returns> documentation [C:\Users\k\Documents\Help\Working\BuildReferenceTopics.proj]
BuildAssembler : warning : ShowMissingComponent: [M:WindowsRuntimeComponent.ByteUtil.ToByteArray(Windows.Foundation.Collections.IVector{System.Byte})] Missing <param name="inBytes"/> documentation [C:\Users\k\Documents\Help\Working\BuildReferenceTopics.proj]

comments

EWoodruff wrote May 29, 2014 at 8:24 PM

I tried your example and it worked fine. This usually means either you haven't got an up to date XML comments file or you have the incorrect configuration selected (Debug vs. Release). Check the log and see which XML comments file it is using and make sure it is up to date. Also, if you've added the assembly directly as the documentation source, make sure you've included the XML comments file too and that the Framework Version is set correctly for the version used by the assembly.

Please note that this project site has been discontinued and may not be monitored as frequently. For future questions or issues concerning Sandcastle or SHFB, post them over on the Sandcastle Help File Builder project's site. Thanks.