Quantcast
Channel: Sandcastle Help File Builder
Viewing all 2184 articles
Browse latest View live
↧

Commented Unassigned: Unresolved assembly reference: System.Core [35641]

October 26, 2014, 10:54 am
$
0
0
Hello,

I am trying to use Sandcastle for generate the documentation for #xlabs project, you can see more here
https://github.com/XLabs/Xamarin-Forms-Labs/issues/393

But I am getting errors


Generating shared content files (en-US, English (United States))...
Last step completed in 00:00:00.0171
-------------------------------
Generating API filter for MRefBuilder...
Last step completed in 00:00:01.0557
-------------------------------
Generating reflection information...
[C:\Windows\Microsoft.NET\Framework64\v4.0.30319\MSBuild.exe]
Build started 26/10/2014 14:03:30.
Project "C:\DevApps\GitHub\Forks\XForms-Toolkit\Help\Working\GenerateRefInfo.proj" on node 1 (default targets).
PrepareForBuild:
Creating directory "obj\Debug\".
GenerateRefInfo:
MRefBuilder (v2014.5.31.0)
Copyright ¸ 2006-2014, Microsoft Corporation, All Rights Reserved.
Portions Copyright ¸ 2006-2014, Eric Woodruff, All Rights Reserved.
Loaded 36 assemblies for reflection and 21 dependency assemblies.
MRefBuilder : error : Unresolved assembly reference: System.Core (System.Core, Version=2.0.5.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e) required by Mono.Android [C:\DevApps\GitHub\Forks\XForms-Toolkit\Help\Working\GenerateRefInfo.proj]
Last step completed in 00:00:05.7941
-------------------------------

SHFB: Error BE0043: Unexpected error detected in last build step. See output above for details.
at SandcastleBuilder.Utils.BuildEngine.BuildProcess.RunProcess(String fileToRun, String args)
at SandcastleBuilder.Utils.BuildEngine.BuildProcess.Build()


but I have it

![Image](http://s27.postimg.org/c7jsc726r/image.png)
Comments: ** Comment from web user: EWoodruff **

Remember that there are many different versions of the .NET Framework. Picking the assemblies from the standard .NET framework used for desktop applications won't work for portable apps, Windows Phone, Silverlight, etc.

Select the proper framework version for the SHFB project using the Framework Version project property. More likely than not, it's one of the .NET Portable versions such as .NET Portable 4.5 based on the error. Leave out the core system assemblies as references as setting the framework will do that for you.

↧
Search

Commented Unassigned: Unresolved assembly reference: System.Core [35641]

October 26, 2014, 11:19 am
$
0
0
Hello,

I am trying to use Sandcastle for generate the documentation for #xlabs project, you can see more here
https://github.com/XLabs/Xamarin-Forms-Labs/issues/393

But I am getting errors


Generating shared content files (en-US, English (United States))...
Last step completed in 00:00:00.0171
-------------------------------
Generating API filter for MRefBuilder...
Last step completed in 00:00:01.0557
-------------------------------
Generating reflection information...
[C:\Windows\Microsoft.NET\Framework64\v4.0.30319\MSBuild.exe]
Build started 26/10/2014 14:03:30.
Project "C:\DevApps\GitHub\Forks\XForms-Toolkit\Help\Working\GenerateRefInfo.proj" on node 1 (default targets).
PrepareForBuild:
Creating directory "obj\Debug\".
GenerateRefInfo:
MRefBuilder (v2014.5.31.0)
Copyright ¸ 2006-2014, Microsoft Corporation, All Rights Reserved.
Portions Copyright ¸ 2006-2014, Eric Woodruff, All Rights Reserved.
Loaded 36 assemblies for reflection and 21 dependency assemblies.
MRefBuilder : error : Unresolved assembly reference: System.Core (System.Core, Version=2.0.5.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e) required by Mono.Android [C:\DevApps\GitHub\Forks\XForms-Toolkit\Help\Working\GenerateRefInfo.proj]
Last step completed in 00:00:05.7941
-------------------------------

SHFB: Error BE0043: Unexpected error detected in last build step. See output above for details.
at SandcastleBuilder.Utils.BuildEngine.BuildProcess.RunProcess(String fileToRun, String args)
at SandcastleBuilder.Utils.BuildEngine.BuildProcess.Build()


but I have it

![Image](http://s27.postimg.org/c7jsc726r/image.png)
Comments: ** Comment from web user: saramgsilva **

This project uses Xamarin.Android and Xamarin.IOS and the dll is related with Xamarin.Android and I went to the Xamarin.Android project, selected the dll and got the full path for the dll, then I added the dll to the project.....

↧
↧

Closed Unassigned: ShowMissingComponent issue [35271]

October 26, 2014, 12:10 pm
$
0
0
I've encountered an issue with ShowMissingComponent.

Here's my case:
Visual Studio 2012 for Windows 8
```
using System.Collections.Generic;

namespace WindowsRuntimeComponent
{
/// <summary>
/// Byte Utility Class.
/// </summary>
public sealed class ByteUtil
{
/// <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();
}
}
}

```

XML:
```
<?xml version="1.0"?>
<doc>
<assembly>
<name>WindowsRuntimeComponent</name>
</assembly>
<members>
<member name="T:WindowsRuntimeComponent.ByteUtil">
<summary>
Byte Utility Class.
</summary>
</member>
<member name="M:WindowsRuntimeComponent.ByteUtil.ToByteArray(System.Collections.Generic.IList{System.Byte})">
<summary>
Byte List To Byte Array.
</summary>
<param name="inBytes">Byte List</param>
<returns>Byte Array</returns>
</member>
</members>
</doc>
```

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: Added WindowsStoreAndPhoneNamer to MRefBuilder that renames the type names changed by the compiler to the expected type names found in the code and XML comments files. This is used automatically when the framework setting is one of the WIndows Store or Windows Phone frameworks.
↧

Commented Unassigned: Unresolved assembly reference: System.Core [35641]

October 26, 2014, 12:14 pm
$
0
0
Hello,

I am trying to use Sandcastle for generate the documentation for #xlabs project, you can see more here
https://github.com/XLabs/Xamarin-Forms-Labs/issues/393

But I am getting errors


Generating shared content files (en-US, English (United States))...
Last step completed in 00:00:00.0171
-------------------------------
Generating API filter for MRefBuilder...
Last step completed in 00:00:01.0557
-------------------------------
Generating reflection information...
[C:\Windows\Microsoft.NET\Framework64\v4.0.30319\MSBuild.exe]
Build started 26/10/2014 14:03:30.
Project "C:\DevApps\GitHub\Forks\XForms-Toolkit\Help\Working\GenerateRefInfo.proj" on node 1 (default targets).
PrepareForBuild:
Creating directory "obj\Debug\".
GenerateRefInfo:
MRefBuilder (v2014.5.31.0)
Copyright ¸ 2006-2014, Microsoft Corporation, All Rights Reserved.
Portions Copyright ¸ 2006-2014, Eric Woodruff, All Rights Reserved.
Loaded 36 assemblies for reflection and 21 dependency assemblies.
MRefBuilder : error : Unresolved assembly reference: System.Core (System.Core, Version=2.0.5.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e) required by Mono.Android [C:\DevApps\GitHub\Forks\XForms-Toolkit\Help\Working\GenerateRefInfo.proj]
Last step completed in 00:00:05.7941
-------------------------------

SHFB: Error BE0043: Unexpected error detected in last build step. See output above for details.
at SandcastleBuilder.Utils.BuildEngine.BuildProcess.RunProcess(String fileToRun, String args)
at SandcastleBuilder.Utils.BuildEngine.BuildProcess.Build()


but I have it

![Image](http://s27.postimg.org/c7jsc726r/image.png)
Comments: ** Comment from web user: EWoodruff **

It's still based on the selected framework in the project and core assemblies are ignored if added as references. Try one as indicated above. If it doesn't work, the Frameworks.xml file found in the SHFB installation folder will need to be updated to support the related Xamarin versions of the framework with references to the location of the assemblies for that particular flavor of the framework.

↧

Closed Unassigned: Problem with default topic in toc.xml [35622]

October 26, 2014, 12:16 pm
$
0
0
Hi,

I've just started using Sandcastle to document a project written using VS2008, .NET Framework 2.0, and it all goes fine until I get this right at the end:

SHFB: Error BE0026: Unable to determine default topic in toc.xml. You may need to mark one as the default topic manually.
at SandcastleBuilder.Utils.BuildEngine.BuildProcess.CombineIntermediateTocFiles()
at SandcastleBuilder.Utils.BuildEngine.BuildProcess.Build()

1) Any idea why?
2) How can I mark a topic as the default manually?
Comments: Not able to duplicate and no further response from the OP after getting the example project. If it's still an issue and an example that demonstrates it can be attached, feel free to reopen the issue. As mentioned, one workaround would be to add a content layout file with a single MAML topic to serve as the default page.
↧
↧

Closed Unassigned: Class reference documentation tree structure support [35312]

October 26, 2014, 12:18 pm
$
0
0
Hi,

We are using sandcastle help file builder for generating class reference documentation. I have generated a sample class reference contents and shared the contents and the project in the below link.
http://www16.zippyshare.com/v/68035049/file.html
Sample Project :
Assemblies used : Microsoft.webpublisher.dll,Microsoft.Windows.Design.Extensibility.dll
Sample Project Output:
http://www16.zippyshare.com/v/56263060/file.html
Here is the requirement :

I have used microsoft windows assembly and web assembly in the project, We want to differentiate the generated contents by including a Header topic as 'Essential Microsoft Windows' and we want the all the namespaces for 'Microsoft.Windows.Design.Extensibility.dll' comes under this topic. Similar to this we need to include the all the web contents under 'Essential Microsoft Web' topic.


Structure:

Essential Microsoft Windows
Microsoft.Windows.Design Namespace
Microsoft.Windows.Design.Features Namespace
Microsoft.Windows.Design.MetaData Namespace
Essential Microsoft Web
Microsoft.WebPublisher Namespace
Note: Maintain both assemblies in same project and we want the output as above mentioned structure.

Kindly suggest us what we have to do for achieving this functionality from our side?

Regards,
Sivaguru

- - - - - - - -

You'll need to write a plug-in for SHFB that modifies the intermediate TOC file (toc.xml in the working folder during the build) probably after the CombiningIntermediateTocFiles build step. It would move selected namespace entries to a new parent topic based on the configuration. See the Creating Build Process Plug-Ins topic in the SHFB help file to get started.

- - - - - - - -

I have referred the 'Creating Build Process Plug-in' help link as suggested. Since i am new to this, it wont work as expected. Could you explain more and share the sample plug-in that matches our requirements (for generating tree structure documentation)
Comments: Not to be implemented. Left to requester to implement.
↧

Closed Feature: Need JavaScript Usage Syntax Generator for use with WinRT components [34856]

October 26, 2014, 12:21 pm
$
0
0
Version: 1.9.8.0, JavaScript Syntax Generator

The following property on a WInRT component:
public SomeType SomeProperty { get; set; }

gets documented as:
get_SomeProperty()
set_SomeProperty()

It should be:
someProperty

01/13/2014 - EFW - The JavaScript syntax generator is not really applicable to the WinRT components. Based on what I've seen for the WinJS classes on MSDN, Microsoft uses something equivalent to a usage syntax similar to the VB or XAML Usage Syntax generator showing examples of creating an instance or assigning a property a value. I think that's what's really needed here.
Comments: Not to be implemented. I don't know enough about WinJS or the expected syntax. If someone with more knowledge on the subject wants to implement a syntax generator for inclusion in SHFB, feel free to do so.
↧

New Post: API Filter UI error

October 27, 2014, 6:06 pm
$
0
0
In the API Filter dialog, after clearing the checkboxes for more than 15 members of a node, when you clear the 16th item in the tree list, it also clears the checkbox of the parent node, causing erroneous output in the project file. This requires direct editing of the project file's Xml.

To reproduce:
  1. Select an API that has at least one class with more than about 20 members.
  2. Check the class node
  3. Clear the checkboxes of 15 member nodes
  4. Observe that when clearing the checkbox of the 16th node, the UI also clears the checkbox of the class node
↧
Search

New Post: API Filter UI error

October 27, 2014, 6:50 pm
$
0
0
The behavior you are seeing is by design and is documented (see the Including and Excluding Members section of the API Filter help topic. It is done to create a more efficient filter. If more than half of the members are omitted, the parent is written out as an exclude entry with child entries just for those marked for inclusion. If more than half are included, the opposite occurs. Building the help file will result in the proper members being included or excluded. If you think you are seeing incorrect behavior with regard to the resulting help file, please supply an example that demonstrates the problem.

Eric
↧
↧

New Post: Please add NuGet support to shfb projects in VisualStudio

October 31, 2014, 4:55 am
↧

New Post: Please add NuGet support to shfb projects in VisualStudio

October 31, 2014, 8:09 am
$
0
0
That doesn't apply in this instance as he wants them in the additional references project where they have to be documentation sources.
↧

Closed Unassigned: Unresolved assembly reference: System.Core [35641]

November 4, 2014, 12:14 pm
$
0
0
Hello,

I am trying to use Sandcastle for generate the documentation for #xlabs project, you can see more here
https://github.com/XLabs/Xamarin-Forms-Labs/issues/393

But I am getting errors


Generating shared content files (en-US, English (United States))...
Last step completed in 00:00:00.0171
-------------------------------
Generating API filter for MRefBuilder...
Last step completed in 00:00:01.0557
-------------------------------
Generating reflection information...
[C:\Windows\Microsoft.NET\Framework64\v4.0.30319\MSBuild.exe]
Build started 26/10/2014 14:03:30.
Project "C:\DevApps\GitHub\Forks\XForms-Toolkit\Help\Working\GenerateRefInfo.proj" on node 1 (default targets).
PrepareForBuild:
Creating directory "obj\Debug\".
GenerateRefInfo:
MRefBuilder (v2014.5.31.0)
Copyright ¸ 2006-2014, Microsoft Corporation, All Rights Reserved.
Portions Copyright ¸ 2006-2014, Eric Woodruff, All Rights Reserved.
Loaded 36 assemblies for reflection and 21 dependency assemblies.
MRefBuilder : error : Unresolved assembly reference: System.Core (System.Core, Version=2.0.5.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e) required by Mono.Android [C:\DevApps\GitHub\Forks\XForms-Toolkit\Help\Working\GenerateRefInfo.proj]
Last step completed in 00:00:05.7941
-------------------------------

SHFB: Error BE0043: Unexpected error detected in last build step. See output above for details.
at SandcastleBuilder.Utils.BuildEngine.BuildProcess.RunProcess(String fileToRun, String args)
at SandcastleBuilder.Utils.BuildEngine.BuildProcess.Build()


but I have it

![Image](http://s27.postimg.org/c7jsc726r/image.png)
Comments: No further reply from OP. If you figured out what framework to use, comment here so that others know what to use. If it will require new framework entries in the Frameworks.xml file somebody with more knowledge of Xamarin, Mono, and Android development will have to figure it out.
↧

New Post: Search doesn't work on website

November 5, 2014, 4:51 am
$
0
0
Hi

We publish our Help on a IIS-Webserver as a website. Since we changed to the new VS2013-Presentation-Style, the Search doesn't work. It don't work with IE11 on Windows 7 or Windows 8.1. But the Search works fine with Chrome or Firefox.

After a while i found the problem in the Script-File branding-Website.js in the Function PerformSearch(). On Line 436 is a comma too much. IE Versions smaller than 11.0.9600.17351 cannot handle this. With Update KB2987107 everything is okay. But for older version the comma must be removed.

This just for informationen ... and maybe to fix.

Greets
Alex
↧
↧

New Post: Search doesn't work on website

November 5, 2014, 8:00 am
$
0
0
Thanks. It's already been reported and fixed for the next release.

Eric
↧

New Post: Missing .NET Framework 4.5.2 in Frameworks.xml

November 5, 2014, 7:24 pm
↧
Search

New Post: Markdown Support

November 6, 2014, 6:25 am
$
0
0
HTML to Markdown is nice, but a converter that would take markdown and turn it into Sandcastle documentation would be a huge time saver too. Probably a little trickier though. Maybe some sweet Resharper templates for the XML!
↧

New Post: Markdown Support

November 6, 2014, 12:21 pm
$
0
0
Anything's possible I suppose. You could create a presentation style with its own set of plug-ins and build components that replace the conceptual content steps to parse markdown to output the HTML rather than XSL transforming the MAML XML. The API content could still go through the normal XSL transformations.

Eric
↧
↧

New Post: Markdown Support

November 6, 2014, 1:22 pm
$
0
0
You wouldn't recommend going to MAML first? That was what I was thinking - that way the build process would catch any link discrepancies, etc. and join it to whatever output was being generated, especially in the even that it was going to a non-HTML destination.
↧

New Post: Markdown Support

November 6, 2014, 4:19 pm
$
0
0
That seems rather redundant if you're creating a presentation style. Either you'd author your conceptual content in MAML or markdown. If you want to author the content in markdown but have it buildable in any help format and presentation style such as Open XML your best bet would be a plug-in that converts and adds the MAML topics to the build similar to the XML Schema Documenter which converts XSD information to MAML. Chances are that would work with any presentation style and output format.

Eric
↧

New Post: Is SHFB portable?

November 8, 2014, 8:22 pm
$
0
0
I usually run SHFB from the command line, e.g. MSBuild.exe MyProject.shfbproj. I check-in the .shfbproj file into source control so I and others can build, but that requires SHFB to be installed.

Do you think it's possible to have a SHFB distribution and can be just downloaded and saved into a project's folder, to be referenced by the .shfbproj file, without depending on any other external state? Perhaps distributed as a NuGet package.

BTW, I'm only interested in Website (HTML) output, not CHM or any other.
↧
Viewing all 2184 articles
Browse latest View live
Search
<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>