Property SDKLinK Type

Topics: Developer Forum, Project Management Forum, User Forum
Dec 14, 2007 at 2:22 AM
Hey this tool for generating the Help file is really great ..But i having a problem with the SDKLinK Type in the Tool .
Say suppose I set it to MSDN the then method parameter appear in the this Format

Parameters
errorCode
String
ErrorCode input parameter. with errode is the parameter name and String the type the both appear bold
BUt when I set it to Index as I want in the links to appear for the type of parameter so that means String will be a hyper link and when I click on it i get the follwoing error
Sorry, no topics were found for the selected link.

Keywords = ""
IndexMoniker =
Source URL =

What should I do to solve this problem and I m using Presentation Style as vs 2005 .It works find if parameter is of type of classin the project .Pls help

THanks
Jinnyb
Coordinator
Dec 14, 2007 at 2:59 AM
The Index link type is only valid in Help 2 files. I believe that even then, it will only work correctly once integrated into a help collection such as that for VS2005. Regarding the non-links when using the MSDN style, I'm not seeing that behavior. The links to the system types are working on the parameters in my projects. Is this a VB.NET project by chance? The VB.NET compiler isn't as diligent about writing out fully qualified type names which can result in the non-links. That is most often seen in the cref attributes on <see> tags. If you have a small example that demonstrates the problem, you can e-mail it to me and I can check it out to be sure. My e-mail address is in the About box and in the footer of the pages in the help file.

Eric
Dec 14, 2007 at 3:47 AM
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Runtime.Serialization;


namespace TestNamespace
{

/// <summary>
/// Tests whether sandcastle can handle all c# tags as defined at http://msdn2.microsoft.com/en-us/library/5ast78ax.aspx.
/// Comments of method "Increment (int step)" include almost all tags.
/// Method "Swap" is used to test generics tags, such as "typeparam".
/// <threadsafety static="true" instance="false"/>
/// </summary>
Serializable()
public class StoredNumber
{

/// <summary>Initializes the stored number class with a starting value.</summary>
/// <param name="value">Initialization</param>
public StoredNumber(int value)
{
number = value;
}

private int number;

/// <preliminary>
/// <para>This method is just for testing right now. It might be removed in the near future</para>
/// </preliminary>
public void PreliminaryTest()
{
}
///<summary>Decrements by One </summary>
/// <overloads>
/// <summary>test overlads tag</summary>
/// </overloads>
///
public void Dec()
{
number--;
}

/// <summary>
/// dec by a specified step
/// </summary>
/// <param name="step"> specified step </param>
public void Dec(int step)
{
number -= step;
}

/// <summary><c>Increment</c> method incriments the stored number by one.
/// <note type="caution">
/// note description here
///</note>
/// <preliminary/>
/// </summary>
public void Increment()
{
number++;
}

/// <summary><c>Increment</c> method incriments the stored number by a specified <paramref name="step"/>.
/// <list type="number">
/// <item>
/// <description>Item 1.</description>
/// </item>
/// <item>
/// <description>Item 2.</description>
/// </item>
/// </list>
/// <para>see <see cref="System.Int32"/></para>
/// <para>seealso <seealso "System.Xml.XmlReader"/></para>
/// <para>see <see cref="System.Xml.XmlReader"/></para>
/// <para>seealso <seealso cref="System.Int64"/></para>
/// </summary>
/// <remarks>
/// You may have some additional information about this class.
/// </remarks>
/// <example> This sample shows how to call the GetZero method.
/// <code>
/// class TestClass
/// {
/// static int Main()
/// {
/// return GetZero();
/// }
/// }
/// </code>
/// </example>
///
/// <exception cref="System.Exception">Thrown when...</exception>
/// <param name="step"> specified step</param>
/// <permission cref="System.Security.PermissionSet">Everyone can access this method.</permission>
/// <returns>Returns nothing</returns>
/// <value>The Name property gets/sets the _name data member.</value>
public void Increment(int step)
{
number = number + step;
}

/// <summary>
/// Testing 1
/// </summary>
/// <param name="iventa">Testing Iventa </param>
/// <returns> String Value</returns>
public String Jinny(String iventa)
{
return iventa;
}
/// <summary>
/// Testing 1
/// </summary>
/// <param name="iventa">Testing Iventa1 </param>
public void Jinny(Int64 iventa)
{

}
/// <summary>
/// <para><typeparam name="T">The element type to swap</typeparam></para>
/// <para>Swap data of type <typeparamref name="T"/></para>
/// </summary>
public void Swap<T>(ref T lhs, ref T rhs)
{
T temp;
temp = lhs;
lhs = rhs;
rhs = temp;
}



/// <summary>Gets the stored number.</summary>
public int Value
{
get
{
return (number);
}
}


private int _myProp;


///<summary>Gets or sets a <see cref="T:System.Windows.Media.Brush"></see> used to fill the area between the borders of a
///<see cref="T:System.Windows.Controls.InkCanvas"></see>.
///see <see langword="null"/> as reference
///</summary>
public int MyProp
{
get { return _myProp; }
set { _myProp = value; }
}

}

}
Here is test class and that I created it is not showing links for the parameter of Dec method and the Jinny method which are string and int32 and I m using C# language .Please do revert back if possible as I have not yet got the solution .
Coordinator
Dec 18, 2007 at 1:46 AM
I'm unable to reproduce the problem. You might check the build log in the BuildAssembler step to see if there are any errors or warnings related to the MSDN web service. If you are behind a proxy server it could be preventing it from connecting to it and that may cause the problem. If so, see the FAQ for info on creating a configuration file that allows it to go through the proxy server.

Eric