I was hoping that Sandcastle would generate HTML similar to that seen in the standard MS documentation in VS 2005. I.e., for a given class, there are separate sections for public/protected methods/properties. The default HTML generated by Sandcastle is of a style I'm not familiar with and don't really care for (none of my parameter descriptions are shown!).
Does anyone know how to generate the HTML documentation I described above
Sandcastle, .NET Framework Doc Style?
barkingdog
I would like to see a screen shot and/or example. Could you please send them to my email listed in my profile and I will be happy to investigate.
Anand..
softwarejaeger
I get the same thing. For example, the method (constructor) in C# with the signature
the parameter shows as sim() rather than just sim in the Parameters section of the generated documentation (the boldfacing and color are mine, not what Sandcastle produces).
— Eric —
MatthieuGD
We will provide you with VS 2005 transforms as a part of one of our CTPs. The look and feel you got with our first CTP is targetted towards our next version of VS.
Anand..
JanMichaelTe
Thanks for the info Anand. Regarding the missing parameter in the current transform, did I mess something up or are they turned off by default The parameters just look like an empty constructor in the HTML:
ParamName()
Before you ask, I do supply <param> tags for each parameter.
Kishore Gopalan
The type of the parameter is supposed to appear in the parenthesis. In the July CTP, there was a bug that it did not. That bug was fixed in the August CTP.< xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />
Anand..
TigerPhoenix
Below is the complete source for the Task constructor mentioned previously...
/// <summary>
/// Create a new <see cref="Task"/> instance that will run under the
/// given simulation context.
/// </summary>
/// <exception cref="ArgumentNullException">
/// If <paramref name="sim"/> is <see langword="null"/>.
/// </exception>
/// <param name="sim">The simulation context.</param>
protected Task(Simulation sim)
{
if (sim == null)
{
throw new ArgumentNullException("sim");
}
this._sim = sim;
}
One thing to point out is that the visibility is actually protected not public like I had indicated in my previous post. As you can see, the sim parameter has a corresponding <param> tag in the XML documentation comment.
— Eric —
SteveMargolis