Sandcastle Work Item Rss Feed

Closed Issue: Failed on localised classes/methods names [922]

DarrenParker — Thu, 16 May 2013 11:53:25 GMT

Sandcastle not support localised classes/methods/identifiers names in C# code.

For example:
public class МойКласс
{
public void МойМетод()
{
// ....
}
}

It success compiled by Visual Sudio (2003-2008), but Sandcastle is failed on XslTransform step.

Result of execution XslTransform:

"C:\Tools\Sandcastle\ProductionTools\XslTransform" /xsl:"C:\Tools\Sandcastle\ProductionTransforms\ReflectionToChmIndex.xsl" reflection.xml /out:"MyHelp.hhk"

Unhandled Exception: System.Text.EncoderFallbackException: Unable to translate Unicode character \u0441 at index 735 to specified code page.
at System.Text.EncoderExceptionFallbackBuffer.Fallback(Char charUnknown, Int32 index)
at System.Xml.CharEntityEncoderFallbackBuffer.Fallback(Char charUnknown, Int32 index)
at System.Text.EncoderFallbackBuffer.InternalFallback(Char ch, Char*& chars)
at System.Text.Latin1Encoding.GetBytes(Char* chars, Int32 charCount, Byte* bytes, Int32 byteCount, EncoderNLS encoder)
at System.Text.EncoderNLS.Convert(Char* chars, Int32 charCount, Byte* bytes, Int32 byteCount, Boolean flush, Int32& charsUsed, Int32& bytesUsed, Boolean& completed)
at System.Text.EncoderNLS.Convert(Char[] chars, Int32 charIndex, Int32 charCount, Byte[] bytes, Int32 byteIndex, Int32 byteCount, Boolean flush, Int32& charsUsed, Int32& bytesUsed, Boolean& completed)
at System.Xml.XmlEncodedRawTextWriter.EncodeChars(Int32 startOffset, Int32 endOffset, Boolean writeAllToStream)
at System.Xml.XmlEncodedRawTextWriter.FlushBuffer()
at System.Xml.XmlEncodedRawTextWriter.WriteRawWithCharChecking(Char* pSrcBegin, Char* pSrcEnd)
at System.Xml.XmlEncodedRawTextWriter.WriteRaw(String data)
at System.Xml.TextEncodedRawTextWriter.WriteString(String textBlock)
at System.Xml.Xsl.Runtime.XmlQueryOutput.WriteString(String text, Boolean disableOutputEscaping)
at System.Xml.Xsl.Runtime.XmlQueryOutput.WriteString(String text)
at <xsl:template name="createIndexEntry">(XmlQueryRuntime {urn:schemas-microsoft-com:xslt-debug}runtime, IList`1 text, IList`1 file)
at <xsl:template match="/">(XmlQueryRuntime {urn:schemas-microsoft-com:xslt-debug}runtime, XPathNavigator {urn:schemas-microsoft-com:xslt-debug}current)
at Root(XmlQueryRuntime {urn:schemas-microsoft-com:xslt-debug}runtime)
at Execute(XmlQueryRuntime {urn:schemas-microsoft-com:xslt-debug}runtime)
at System.Xml.Xsl.XmlILCommand.Execute(Object defaultDocument, XmlResolver dataSources, XsltArgumentList argumentList, XmlSequenceWriter results)
at System.Xml.Xsl.XmlILCommand.Execute(Object defaultDocument, XmlResolver dataSources, XsltArgumentList argumentList, XmlWriter writer, Boolean closeWriter)
at System.Xml.Xsl.XmlILCommand.Execute(XmlReader contextDocument, XmlResolver dataSources, XsltArgumentList argumentList, XmlWriter results)
at System.Xml.Xsl.XslCompiledTransform.Transform(XmlReader input, XsltArgumentList arguments, XmlWriter results)
at Microsoft.Ddue.Tools.XslTransformer.Main(String[] args)
Last step completed in 00:00:19.2783

BUILD FAILED: Unexpected error in last build step. See output above for details.

Commented Issue: Generation of API documentation for inherited members when DocumentInheritedMembers is false [12784]

EWoodruff — Fri, 01 Feb 2013 20:33:05 GMT

We are using Sandcastle to generate our API Reference, but we do not want to include inherited members. That's why we have set the DocumentInheritedMembers to false. But for some of our classes we still get inherited members in the documentation. After some testing we found that the issue occurs when the child class and the parent class have similar names. And by similar I mean that the parent class has the same name as the child, but with some more letters at the end. For example:
```
public abstract class ChildClassBase
{
public int PublicProp1 { get; set; }
public string PublicProp2 { get; set; }
private int privateProp1 { get; set; }
private string privateProp2 { get; set; }
}

public class ChildClass : ChildClassBase
{
public string ChildProp1 { get; set; }
}
```
In the documentation of ChildClass you will see descriptions for ChildProp1, PublicProp1 and PublicProp2. The same is valid if the parent class is named ChildClassTest, ChildClassT, etc. But if I rename the parent or the child, for example ChildSubClass and ChildClassBase, the documentation for ChildSubClass will hold only information about ChildProp1.
Just one more thing to add - all visibility properties in our project are set to false.

The issue is reproduced with Sandcastle 1.9.5 and 1.9.6 (I haven't tested it in older version.
Comments: ** Comment from web user: EWoodruff **

The code that strips out inherited members does an XPath starts-with() comparison to find them. I added a period to the end of the type name to limit what it finds to just those members belonging to the specific type rather than those matching the prefix which was too inclusive. It's fixed for the next release of SHFB.

Also, please note that this project has been discontinued and may not be monitored as frequently and I can't close work items here. For future questions or issues concerning Sandcastle or SHFB, post them over in the [Sandcastle Help File Builder](http://shfb.codeplex.com) project. Thanks.

Created Issue: Generation of API documentation for inherited members when DocumentInheritedMembers is false [12784]

RosenVl — Wed, 30 Jan 2013 09:28:14 GMT

Commented Issue: SandcastleGUI unable to resolve assmebly reference although it should. [1014]

EWoodruff — Wed, 21 Nov 2012 17:53:43 GMT

I use the NIDaq software from national intruments and it comes with some .net 2.0 assemblies. Every time I try to compile my help using SandcastleGUI, I get the following error:
 
 "Error: Unresolved assembly reference: NationalInstruments.Common (NationalInstruments.Common, Version=8.1.20.168, Culture=neutral, PublicKeyToken=4544464cdeaab541) required by
 NationalInstruments.DAQmx"
 
I have checked that all the necessary assemblies are there. The problem is that the onlyi available NationalInstruments.Common assembly is version 8.1.20.237. However, my program and NIDAQ work fine. I think what is happening is that NationalInstruments.DAQmx does not specifically require version .168 (specific version = false) and that sandcastle is not checking this?
 
Attached are the files in question...

Comments: ** Comment from web user: EWoodruff **

Assembly binding redirection support is built into the latest release of MRefBuilder (Sandcastle 2.7.1.0). If using the Sandcastle Help File Builder, add the assembly binding redirection plug-in to your SHFB project and configure it to redirect the older versions to the latest release or the one one you are using. If you run into any issues, please post a message in the discussion group of the Sandcastle Help File Builder project (http://shfb.codeplex.com) as all future development of the Sandcastle tools will be handled there. Thanks.

Commented Issue: SandcastleGUI unable to resolve assmebly reference although it should. [1014]

fschricker — Wed, 21 Nov 2012 12:41:35 GMT

This is four years old but still I dare posting: Is there any workaround for such a situation? I am struggling with this, albeit with a new NI release.

regards,
Florian

Commented Issue: VS 2010 styles not working in VisualStudio 2012 help system [12480]

EWoodruff — Mon, 01 Oct 2012 01:26:03 GMT

The VS 2010 styles wont work at all, only blank pages will be displayed when clicking in the help topics.
The VS 2005 styles do work but these are a little boring!

Maybe a new 2012 style is needed to make it work!
Comments: ** Comment from web user: EWoodruff **

Supporting Help Viewer 2.0 turned out to be quite hard as it has a number of behavioral differences compared to Help Viewer 1.0. However, I've finally got all of the issue worked out. In the process I got rid of the dev10.mshc dependency. I ended up creating a file by that name containing a minimal set of transformations to get it to produce output for the time being. It will go away in a future release.

Commented Issue: VS 2010 styles not working in VisualStudio 2012 help system [12480]

EWoodruff — Sun, 23 Sep 2012 00:04:38 GMT

Naming method doesn't have anything to do with it as far as I know. There were a couple of fixes that needed to be made to the branding component and a branding transformation and a couple of fixes to the resolve link components. With those changes in place, the content shows up and the links work. There are a few quirks with the topic display but I think it'll do for the time being until a closer look can be taken at it to fix up those issues and get rid of the dependence on the dev10.mshc file which is no longer part of the MS Help Viewer stuff that comes with VS 2012.

Commented Issue: Help file doesn't contain members [12493]

rschwenn — Sat, 22 Sep 2012 16:23:34 GMT

Hi,
I've successfully used SHFB for code documenting using VS projects as documentation source. But now I downloaded the Reactive Extensions Library (http://msdn.microsoft.com/en-us/library/hh242986%28VS.103%29.aspx) which comes with DLL's and XML's only. So I fed SHFB only with DLL and XML files as documentation source.

The resulting help file lists namespaces and classes, but no members. (Attached are my SHFB settings files.)

Is this a case that isn't really supported or can't work by some reason?
Comments: ** Comment from web user: rschwenn **

Never mind:
The documented classes are associated to the System name space. Hence they are recognized by SHFB as "InheritedFrameworkMembers". Since the option to document them has been disabled, the members of such classes didn't appear in both the TOC and the Class pages.

Created Issue: Help file doesn't contain members [12494]

rschwenn — Fri, 21 Sep 2012 22:27:47 GMT

Created Issue: Help file doesn't contain members [12493]

rschwenn — Fri, 21 Sep 2012 22:17:41 GMT

Commented Issue: VS 2010 styles not working in VisualStudio 2012 help system [12480]

rschwenn — Fri, 21 Sep 2012 20:46:49 GMT

Try to set "NamingMethod" (node Help File) to "MemberName".

Created Issue: VS 2010 styles not working in VisualStudio 2012 help system [12480]

bjallemad — Wed, 12 Sep 2012 15:11:19 GMT

Commented Issue: Cannot resolve assembly reference: Windows [12071]

EWoodruff — Sun, 09 Sep 2012 19:53:17 GMT

Hi all,

I'm working in a metro app style project
This is error I got when generating documentation:
MREFBUILDER : error : Unresolved assembly reference: Windows (Windows, Version=255.255.255.255, Culture=neutral, PublicKeyToken=null)

Windows here is a dependency assembly which has properties like in attached pic. But there is nothing helpful in the path.
It's a default reference of every metro application project and cannot be remove, what do I support to do to get over this?

Any help or idea to solve problem would be greatly appreciated, thx!
Comments: ** Comment from web user: EWoodruff **

I've modified the standalone GUI so that it recognizes *.winmd files as reference assemblies. The current release filters out anything other than *.exe and *.dll. The VSPackage is capable of adding the references but you do need to explicitly change the filename filter in the Open File dialog to show "*.*" so that you can pick it. I'm looking into support Windows Store Apps as a framework type so that this isn't an issue.

Commented Issue: MREFBUILDER : error : Unresolved assembly reference [11747]

TATWORTH — Thu, 23 Aug 2012 11:32:46 GMT

Generating Docs from an assembly that uses SAP BusinessObjects Crystal Reports ends up in a missing reference.
In fact, the mentioned assembly "BusinessObjects.Licensing.KeycodeDecoder" cannot be found anywhere on my machine.

Can anyone explain, why loading and executing my assembly is not a problem for the .NET runtime but for MRefBuilder?

See my output:

Generating reflection information...
[C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe]
MrefBuilder (v2.6.10621.1)
Copyright ¸ Microsoft 2006
Info: Loaded 1 assemblies for reflection and 0 dependency assemblies.
MREFBUILDER : error : Unresolved assembly reference: BusinessObjects.Licensing.KeycodeDecoder (BusinessObjects.Licensing.KeycodeDecoder, Version=13.0.2000.0, Culture=neutral, PublicKeyToken=692fbea5521e1304) required by CrystalDecisions.CrystalReports.Engine
Comments: ** Comment from web user: TATWORTH **

There is a fix for Unresolved assembly reference: BusinessObjects.Licensing.KeycodeDecoder discussed at http://sandcastlestyles.codeplex.com/discussions/360116 and there will be a permanent fix done in the Sandcastle build due to be released in Oct 2012!

Commented Issue: sitemap element has multiple siteMapNode elements in the web.sitemap file generated [2158]

EWoodruff — Fri, 17 Aug 2012 19:56:48 GMT

Tried to create web documents for multiple api using
scbuild –framework 2.0 –source C:\UTS\PEARL\Src\TMS\bin\TMS.Pearl.SF.Collections.*.dll,C:\UTS\PEARL\Src\TMS\bin\TMS.Pearl.SF.Collections.*.xml –BuildWebsite -name C:\TestSCWebsite. This generated the web.sitemap file under api directory which had multiple siteMapNode elements. This structure in the web.sitemap caused the following error during runtime during the processing of the following methods

Exactly one <siteMapNode> element is required directly inside the <siteMap> element.

System.Web.XmlSiteMapProvider.BuildSiteMap()
System.Web.XmlSiteMapProvider.get_RootNode()
Comments: ** Comment from web user: EWoodruff **

It's actually the api/web.sitemap file that is the problem. This error is caused by documenting one or more assemblies with two or more namespaces. The fix was to add the "/arg:project=Project" option to the XslTransform calls in the Reflection target in Generic.targets so that it creates a namespace container node. This wraps the namespaces in a parent node thus satisfying the site map validation rule.

Commented Issue: VS2010 Presentation Style misses line breaks in code examples using Firefox [12304]

EWoodruff — Thu, 16 Aug 2012 19:32:24 GMT

Using the new beta presentation style VS2010 the code examples are displayed in a signle, very long line when using Firefox v6 and v12. Line breaks are correctly displayed when viewing the same documentation using the Internet Explorer v8.
The Presentation Style VS2005 works as expected in both browers.
Comments: ** Comment from web user: EWoodruff **

I removed the style element from the branding transformation as it didn't seem to serve any purpose and the code is formatted correctly without it as JBaehr noted in the related SHFB work item.

Commented Issue: Nested Class Constructor Does Not Show Up [12074]

rpkrajewski — Tue, 07 Aug 2012 20:02:25 GMT

We have a nested class with a public constructor. It is marked as deprecated, but is still public and preset. NDoc generated the documentation for it, but Sandcastle 2.7.0.0 apparently does not.
Comments: ** Comment from web user: rpkrajewski **

Thanks!

Commented Issue: Nested Class Constructor Does Not Show Up [12074]

EWoodruff — Tue, 07 Aug 2012 19:33:59 GMT

With regard to processing the XML comments file to remove unwanted members, SHFB provides an IntelliSense build component that you can add to the project which will produce a filtered XML comments file containing only the documented members.

Commented Issue: Nested Class Constructor Does Not Show Up [12074]

EWoodruff — Tue, 07 Aug 2012 19:31:51 GMT

The problem here is that you are using <exclude /> XML comment tags which are converted by SHFB to API Filter entries. Since MRefBuilder's API filter will rip all members with the given name and does not distinguish by parameter list, if one overload is removed, they all are. Since you don't appear to be documenting internals, remove the <exclude /> tag from the internal constructor and the public one will show up. It would probably be best to remove all <exclude /> tags and use the API filter property within the project to remove any unwanted members so that it's more obvious what is being removed.

Commented Issue: My generic class gets StackOverflowException by MRefBuilder (v2.7.0.0) [12270]

EWoodruff — Tue, 07 Aug 2012 19:19:42 GMT

My public generic class gets an unexpected error during build step in SHFB stating "Process is terminated due to StackOverflowException". I have attached the sample Visual Studio project in the attachment section below. Given the following code, whether MyClass is abstract or partial creates the error.

namespace MyClassLibrary
{
/// <summary>
/// MyClass Summary
/// </summary>
/// <typeparam name="TD"></typeparam>
/// <typeparam name="TT"></typeparam>
public abstract partial class MyClass<TD, TT>
{
/// <summary>
/// IBase Summary
/// </summary>
public interface IBase
{
NestedClass<T> RequestElementsTyped<T>();
}

/// <summary>
/// NestedClass Summary
/// </summary>
/// <typeparam name="T"></typeparam>
public class NestedClass<T> : IEquatable<NestedClass<T>>
{
public bool Equals(NestedClass<T> other)
{
throw new NotImplementedException();
}
}

/// <summary>
/// IAnother Summary
/// </summary>
public interface IAnother : IBase { }
}
}

Given build output:

-------------------------------
[Sandcastle Help File Builder, version 1.9.4.0]
Creating output and working folders...
-------------------------------
Clearing working folder...
-------------------------------
Finding tools...
Found Sandcastle tools in 'C:\Program Files (x86)\Sandcastle\'
Searching for HTML Help 1 compiler...
Found HTML Help 1 compiler in 'C:\Program Files (x86)\HTML Help Workshop\'
-------------------------------
Validating and copying documentation source information
Source: C:\Users\rdewan\Documents\Visual Studio 2010\Projects\ClassLibrary1\MyClassLibrary\bin\Debug\MyClassLibrary.dll
Found assembly 'C:\Users\rdewan\Documents\Visual Studio 2010\Projects\ClassLibrary1\MyClassLibrary\bin\Debug\MyClassLibrary.dll'
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.0040
-------------------------------
Generating API filter for MRefBuilder...
Last step completed in 00:00:00.0010
-------------------------------
Generating reflection information...
[C:\Windows\Microsoft.NET\Framework64\v4.0.30319\MSBuild.exe]
MRefBuilder (v2.7.0.0)
Copyright ¸ 2006-2012, Microsoft Corporation, All Rights Reserved
Info: Loaded 1 assemblies for reflection and 0 dependency assemblies.

Process is terminated due to StackOverflowException.
C:\Users\rdewan\Documents\Help\Working\GenerateRefInfo.proj(53,5): error MSB6006: "MRefBuilder.exe" exited with code -1073741571.
Last step completed in 00:00:25.2013
-------------------------------

SHFB: Error BE0043: Unexpected error detected in last build step. See output above for details.
Comments: ** Comment from web user: EWoodruff **

As I suspected, it was a similar issue to a case I'd already fixed. The nested type referencing itself was causing a stack overflow. I applied a similar fix to prevent it going too far and it will be in the next release.