Windows Live Alerts
Welcome to MSDN Blogs Sign in | Join | Help

Sandcastle

Documentation compilers for managed class libraries
Announcing November 2006 Sandcastle CTP

The November 2006 CTP version for Sandcastle is now available for download at http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en. Our sincere thanks to the Sandcastle user community and to Eric Woodruff for providing us with valuable feedback.

What's new in this version:

  1. Support for the following nDoc custom tags:
    1. <overloads>
    2. <preliminary>
    3. <threadsafety>
    4. <note
  2. Generating Friendly HTM names (A new transform "AddFriendlyFilenames.xsl" has been provided)
  3. Exclude (Ripping) Namespace, types and members (Configured through MrefBuilder.config)
  4. VS 2005 transforms support for FireFox

Changes in this version:

1.    Moved cpref_reflection folder from Examples to Data directory

2.    Consistent versioning (2.2.00) of all assemblies and executables in ProductionTools folder

3.    All assemblies and executable are now under a flat structure in ProductionTools folder

4.    Updated Sandcastle.config files for Prototype and VS2005 to reflect the above changes

Issues Fixed in this Version:

  1. Modify config files to make sure the assembly and reflection data is correct
  2. VS2005 style and other minor isssues.
  3. Common documentation for overloaded methods
  4. Generate freindly HTM names from Sandcastle
  5. System.NullReferenceException related to interface implementation
  6. Support custom tags in Sandcastle
  7. Mrefbuilder incorrectly lists parameter type for generic class
  8. Bug in mshelp: link keyowrd prevending Sandcastle generated HxS integration in Visual Studio

 I would love to hear your feedback about this CTP.

 

Anand...

Posted: Saturday, November 11, 2006 1:05 AM by aram
Filed under:

Comments

Sandcastle November CTP « ???????????? ???????????????? ???????????????????????? said:

PingBack from http://nzeemin.wordpress.com/2006/11/11/sandcastle-november-ctp-2/

# November 11, 2006 6:09 AM

CoqBlog said:

la CTP de Novembre de Sandcastle est disponible . Au menu : What's new in this version: Support for the

# November 11, 2006 3:26 PM

Smöråkning said:

Anand has released yet a new version of the Sandcastle CTP . The November CTP has a couple of fixes and

# November 12, 2006 9:32 AM

andlju said:

I have just released an updated version of the MSBuild script for Sandcastle. It's now found on a dedicated CodePlex site.

You can download it from here:

http://www.codeplex.com/Release/ProjectReleases.aspx?ProjectName=MSBuildSandcastle&ReleaseId=1029

# November 12, 2006 9:42 AM

Riptide said:

I need to generate documents in east Asia languages,such as Chinese. But when generating chm, the transforms output is encoded as iso-8859-1,so it doesn't work. I have to modify ReflectionToChmContents.xsl,ReflectionToChmIndex.xsl and ReflectionToChmProject.xsl to change xsl:output  encoding="iso-8859-1" to encoding="utf-8".

and it works now.

# November 12, 2006 12:24 PM

aram said:

I tried and changing ‘iso-8859-1’ to ‘utf-8’ does not work for me, Chinese characters are not displayed correctly. I have to use ‘gb2132’  (simplified Chinese) and do modification to ReflectionToChmProjects.xsl as below.

<!--<xsl:text>Language=0x409 English (United States)&#x0a;</xsl:text>-->

<xsl:text>Language=0x804 Chinese(PRC) &#x0a;</xsl:text>

Anand..

# November 13, 2006 3:15 AM

t4rzsan said:

I am having some problems with the generated .chm file.  When viewing the contents I keep getting some scripting error saying "CookieDataStore is not defined".  What am I doing wrong?

Thank you.

# November 14, 2006 7:46 AM

JBanks said:

Hi,

Could you provide a detailed way to exclude(Ripping) specific types and members? I need this for documenting classes that inherit and have the browsable attribute set to false on specific properties. I looked in the MRefBuilder.config but could not deduce what was needed.

Thanks in advance. :)

# November 15, 2006 7:18 AM

CWeiss said:

I'm running into troubles with MRefBuilder - I'm trying to use it in a NANT script similar to how Diederik Kros documented at http://www.codeproject.com/useritems/ccnetsandcastle.asp.

The crux of the problem is that MrefBuilder seems to not be recognizing the /dep: argument I'm passing to it.

My call looks like: C:\Program Files\Sandcastle\productiontools\mrefbuilder.exe D:\Daily\Framework/Main/Project1/bin/debug/*.dll D:\Daily\Framework/Main/Project1/bin/debug/*.exe /out:reflection.org1.xml /dep:D:\Daily\Framework\[BUILDMACHINE] Daily - Create docs\SandcastleWorkingDir\dependencies\*.dll

MRefBuilder is not finding the dependency files I've copied to the folder specified. If I put the dependency files in the source folder (D:\Daily\Framework/Main/Project1/bin/debug/), MRefBuilder executes fine.

Any idea what's going on?

# November 15, 2006 1:02 PM

firedog said:

Everything seems good but in the end my chm files are blank. Can anyone help? Thanks.

# November 23, 2006 8:38 AM

aram said:

CWeiss & Firedog,

Please contact me via email. You can send an email through the "email" tab at the top of this page and I will be happy to help.

Anand..

# November 23, 2006 12:03 PM

john.carneiro said:

The 2006 November CTP only adds in the XML file comments in the *.CHM file but the *.HTM pages are missing them. In the 2006 August CTP, it had been working fine. Is this a known defect?

I use the Presentation files from "C:\Program Files\Sandcastle\Presentation\vs2005" vs "C:\Program Files\Sandcastle\Presentation\Prototype".

Below is the command line log, cut for brevity:

MRefBuilder D:\Everest\doc\Library\Output\comments\*.* /out:reflection.org /dep:D:\Everest\doc\Library\Output\dependencies\*.dll /dep:"C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\System.Configuration.dll"

.MrefBuilder (v2.2.2505.29190)

.Copyright c Microsoft 2006

.Info: Loaded 20 assemblies for reflection and 37 dependency assemblies.

.Info: Wrote information on 17 namespaces, 243 types, and 1822 members

XslTransform /xsl:"C:\Program Files\Sandcastle\ProductionTransforms\AddOverloads.xsl" /xsl:"C:\Program Files\Sandcastle\ProductionTransforms\AddGuidFilenames.xsl" reflection.org /out:reflection.xml

.XslTransform (v2.2.2505.29188)

.Copyright c Microsoft 2005-2006

.Info: Applying XSL transformation 'C:\Program Files\Sandcastle\ProductionTransforms\AddOverloads.xsl'.

.Info: Applying XSL transformation 'C:\Program Files\Sandcastle\ProductionTransforms\AddGuidFilenames.xsl'.

XslTransform /xsl:"C:\Program Files\Sandcastle\ProductionTransforms\ReflectionToManifest.xsl" reflection.xml /out:manifest.xml

.XslTransform (v2.2.2505.29188)

.Copyright c Microsoft 2005-2006

.Info: Applying XSL transformation 'C:\Program Files\Sandcastle\ProductionTransforms\ReflectionToManifest.xsl'.

BuildAssembler /config:sandcastle.config manifest.xml

.BuildAssembler (v2.2.2505.29189)

.Copyright c Microsoft 2006

.Info: CopyFromFileComponent: Instantiating component.

.Info: CopyFromFileComponent: Loading data file 'C:\Program Files\Sandcastle\Presentation\vs2005\Transforms\skeleton.xml'.

.Info: CopyFromIndexComponent: Instantiating component.

.Info: CopyFromIndexComponent: Searching for files that match 'reflection.xml'.

.Info: CopyFromIndexComponent: Found 1 files.

.Info: CopyFromIndexComponent: Searching for files that match 'C:\Program Files\Sandcastle\Data\cpref_reflection\*.xml'.

.Info: CopyFromIndexComponent: Found 1 files.

.Info: CopyFromIndexComponent: Indexed 74057 elements.

.Info: CopyFromIndexComponent: Instantiating component.

.Info: ForEachComponent: Instantiating component.

.Info: ForEachComponent: Loading subcomponents.

.Info: CopyFromIndexComponent: Instantiating component.

.Info: ForEachComponent: Loaded 1 subcomponents.

.Info: IfThenComponent: Instantiating component.

.Info: SyntaxComponent: Instantiating component.

.Info: SyntaxComponent: Loaded 3 syntax generators.

.Info: CopyFromIndexComponent: Instantiating component.

.Info: CopyFromIndexComponent: Searching for files that match 'comments/*.xml'.

.Info: CopyFromIndexComponent: Found 24 files.

.Info: CopyFromIndexComponent: Searching for files that match 'C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\*.xml'.

.Info: CopyFromIndexComponent: Found 65 files.

.Info: CopyFromIndexComponent: Indexed 78264 elements.

.Info: ForEachComponent: Instantiating component.

.Info: ForEachComponent: Loading subcomponents.

.Info: IfThenComponent: Instantiating component.

.Info: CopyFromIndexComponent: Instantiating component.

.Info: CopyFromIndexComponent: Instantiating component.

.Info: ForEachComponent: Loaded 2 subcomponents.

.Info: TransformComponent: Instantiating component.

.Info: SharedContentComponent: Instantiating component.

.Info: SharedContentComponent: Loading shared content file 'C:\Program Files\Sandcastle\Presentation\vs2005\content\shared_content.xml'.

.Info: SharedContentComponent: Loading shared content file 'C:\Program Files\Sandcastle\Presentation\vs2005\content\reference_content.xml'.

.Info: SharedContentComponent: Loading shared content file 'C:\Program Files\Sandcastle\Presentation\vs2005\content\syntax_content.xml'.

.Info: SharedContentComponent: Loaded 192 shared content items.

.Info: ResolveReferenceLinksComponent: Instantiating component.

.Info: ResolveReferenceLinksComponent: Indexed 83071 reference link targets.

.Info: SaveComponent: Instantiating component.

.Info: BuildAssembler: Building topic R:Project

.Info: BuildAssembler: Building topic N:Waters.Lib

.Info: BuildAssembler: Building topic T:Waters.Lib.CorDescriptorNameNotFound

.Info: ResolveReferenceLinksComponent: Preparing to query MSDN topic URL web service.

.Info: BuildAssembler: Building topic Overload:Waters.Lib.CorDescriptorNameNotFound.#ctor

.Info: BuildAssembler: Building topic M:Waters.Lib.CorDescriptorNameNotFound.#ctor

.

.

. etc...

# December 6, 2006 1:36 PM

aram said:

John,

I got your email and will respond. There is no change in the functionality and HTM files are always generated before getting them compiled into a CHM.

Anand..

# December 6, 2006 1:44 PM

john.carneiro said:

NDOC had a feature where if you had a dummy class named NamespaceDoc.cs, it would use the <summary> triple slash comments that appear there as the header documentation for the namespace it utilizes in the generated documentation.

Is there a way to get the 2006 November CTP to do this as it is, or via a configuration change, or xml file change? If not is this functionality planned for the future?

# December 6, 2006 1:45 PM

aram said:

Please see this post. You can achieve this by editing your comments.xml file or by passing a seperate file during build.

Anand..

# December 6, 2006 1:55 PM

aram said:

Forgot to include the post. Please see http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=958310&SiteID=1

# December 6, 2006 1:56 PM
Anonymous comments are disabled

Page view tracker