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

New Post: Visual Studio integration for SandCastle Help File Builder v2014.4.22.0

$
0
0
As noted on the download page, on some systems, the content of the ZIP file is blocked and the installer may fail to run. Before extracting it, right click on the ZIP file, select Properties, and click on the Unblock button if it is present in the lower right corner of the General tab in the properties dialog.

Eric

Created Unassigned: MRefBuilder doesnt provide attribute information for method parameters [35268]

$
0
0
Currently MRefBuilder doesnt provide all attribute information for method parameters.

Adding those lines to MRefBuilder/MRefWriter.cs below seems should solve that:

```
private void WriteParameter(Parameter parameter)
{
...

if (parameter.Attributes != null && parameter.Attributes.Count > 0)
WriteAttributes(parameter.Attributes, new SecurityAttributeList());

writer.WriteEndElement();
}
```

After that attribute info will be present in reflection.org and could be analyzed in build plugins if needed.

New Post: Visual Studio integration for SandCastle Help File Builder v2014.4.22.0

$
0
0
Thanks Eric! I tried what you have suggested but that doesn't work for me still.

New Post: Visual Studio integration for SandCastle Help File Builder v2014.4.22.0

$
0
0
I suppose if you are not an administrator on the PC it may stop it from running. You can try right clicking on it and selecting "Run as administrator". If that doesn't work, I don't know why it isn't running.

Eric

Created Unassigned: ShowMissingComponent issue [35271]

$
0
0
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();
}
```

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]

```

Commented Unassigned: ShowMissingComponent issue [35271]

$
0
0
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();
}
```

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: ** Comment from web user: EWoodruff **

Please note the member IDs in the warnings. They are unrelated to the member you posted above:

M:WindowsRuntimeComponent.ByteUtil.ToByteArray(Windows.Foundation.Collections.IVector{System.Byte})

That is not ToByteArray(**IList<byte>** inBytes). You need to find the member it's complaining about which is not that one unless the compiler is translating it somehow behind the scenes. If that's the case, what framework version and project type are you using?

New Post: Which tag for TOC entry?

$
0
0
Hello,

I am creating some AML files to be used in a conceptual document.

I understand that there is a table of content entry for each AML file, but can I create TOC entries for sections within an AML?

This ties in with a larger question of exactly which modifieers are available for each tag. The section tag for example. All I'm aware of is the address tag, because it was autocreated for me.

Probably its a matter of me not knowing the proper names for things, but googling "Sandcastle section" or "Sandcastle TOC" gets me nowhere.

cheers,

Marc

New Post: Which tag for TOC entry?

$
0
0
The content layout file alone determines the TOC layout. The address attribute on section elements is for linking so that you can jump to a specific section from another topic or from within the same topic. It has no bearing on the TOC. If you use the autoOutline element within the topic's introduction, it will create links to each section within the topic intro.

There are help files for SHFB, MAML, and XML comments installed locally as well as being available online. The MAML Guide describes the various MAML elements and their attributes. See the Conceptual Content topics in the SHFB help file for general information on conceptual content.

In this particular case, section is one element that doesn't have a separate topic in the MAML guide. It's covered in more general terms in the comments in each of the examples under the Topic File topic. I probably should add a few more topics for some of the common block elements such as section.

Eric

New Post: Which tag for TOC entry?

$
0
0
Thanks Eric,

So the only way to get more TOC entries is to break things up into smaller files?

Marc

Commented Unassigned: ShowMissingComponent issue [35271]

$
0
0
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();
}
```

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: ** Comment from web user: k_kato **

* Framework version: .NET for Windows Store apps .NETCore,Version=v4.5 (Visual Studio 2012 for Windows 8)
* Project type: Windows Runtime Component

New Post: Which tag for TOC entry?

$
0
0
Yes, that is the only way short of writing a plug-in to modify the TOC. It would have to search the topics for section elements with address attributes and add them to the intermediate TOC file with the section title. Even then I'm not sure how well it would work. It certainly wouldn't work for MS Help Viewer output since the TOC is built off of the metadata in each topic so no sub-section support there. It would probably work for website output. Help 1 and Help 2 I'm not sure, it might but it might not.

Eric

New Post: Code snippets

$
0
0
Thanks, is there a way to import code given an xpath expression ?

I find it not easy to share code examples between reference content and conceptual content.

The more i think about it, the more it makes sense to put the code examples in the csproj, but then i don't see how i can access these from the conceptual content.

What would you recommend for this scenario ?
Thanks

New Post: MAML tag

$
0
0
Hello,

I know the <index> tag doesn't exist, but maybe the equivalent functionality exists and I just haven't found it... What I'm looking for is the ability to add items to the index for conceptual content files from within the document itself.

I know that I can add them manually in the Content Layout file editor, but it would be way more convenient to do it as I'm writing the file.

cheers,

Marc

New Post: Code snippets

$
0
0
If you want to use an XML file and XPath, you need to use an include element but that's only valid from XML comments. As I mentioned above, use the source and region attributes on the code element to import code from a file. That method works in both XML comments and conceptual topics and is used identically in both.

Eric

New Post: MAML tag

$
0
0
Conceptual topics like XML comments have no index element equivalents.

Eric

New Post: Code snippets

$
0
0
That's the way I do it now, using the include element.
In my csharp projects I have an examples folder where I store one XML file per documented class containing the examples for that class.
The advantage is that I can reference the same example from several XML comment places using the appropriate xpath query.
Usually I have one or more example per method, and at the class level I include all examples for all the methods of the class.

It works well. The only problem is that I can't access these examples in the conceptual topics, I hoped there was a way to access the XML generated by the compiler in some way. In fact I don't need to access the example file itself, extracting the example node in generated XML would be fine as I know the code entity reference I want to access.

Is there a way to access the XML documentation source from a conceptual topic ?

Thanks.

New Post: Code snippets

$
0
0
You can write a build component that handles a custom include element in conceptual topics but it would largely be doing what the code block component is doing already but with XPath queries instead.

Eric

New Post: Replacing page breaks by section breaks in Open XML Document style

New Post: How to hide Inheritance Hierarchy?

$
0
0
Thank you Eric for the prompt response!

Regards,
Mikhail

New Post: Replacing page breaks by section breaks in Open XML Document style

$
0
0
Eric,

Is there any way to place a member description to the class description instead of having a separate page for the member?
That would partially solve the problem with the space used...

Thanks,
Mikhail
Viewing all 2184 articles
Browse latest View live


<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>