Primitive Type Inconsistency

Topics: User Forum
Oct 29, 2009 at 9:13 PM
Edited Oct 29, 2009 at 9:14 PM

When a method's signature contains the type name of one of the primitive types, e.g., Int64, the resulting documentation is inconsistent about using type names.

Example:

A method written as this:

  public void Truncate(Int64 u)

yields the following documentation, referring to both 'long' and 'Int64':

public void Truncate(
	long u
)
Parameters
u
Int64
The bit length to use.

Is there any way to get both references to say 'Int64'?

If not, would you consider this for a future version, and is there any way to get both references to say 'long'?  (Changing all signatures in the code to say 'long' instead of Int64 is not an acceptable solution.)

This is with HelpFileFormat=Website, PresentationStyle=hana.

Coordinator
Oct 30, 2009 at 4:01 PM

This is in Sandcastle itself so it's not something I can fix in SHFB.

Eric

 

Oct 31, 2009 at 12:46 AM

Are you in touch with the Sancaste devs?  If so, could you ask them about this?

Coordinator
Oct 31, 2009 at 3:21 AM

You can open a work item in the Sandcastle project.

Eric

Oct 31, 2009 at 7:44 PM

By "work item", do you mean a new item in the "Issue Tracker" section, a new item in the discussion forums, or something else?

Coordinator
Nov 1, 2009 at 9:14 PM

Work items are created on the Issue Tracker tab.

Eric