locked
latest CTP release example : not working RRS feed

  • Question

  • just to give you a feedback :

    I downloaded latest release of sandcastle.

    I just wanted to run the sample

    First reaction : "Where is the "Doc" Folder ?" <= could not find it, why ?? Should i "guess" the commands and tools usage ?

     

    Then i launched the bat script into "Examples" folder, to see how it works.

    Not working (here is the output i get :  see below )

     

     

     (PS : my question is "how should people begin if the sample is not working ? what is the best practice, what are the commands etc, as we don't have any documentation included with the project")

     

     

    Setting environment for using Microsoft Visual Studio 2005 x86 tools.

    D:\Microsoft Visual Studio 8\VC>c:

    C:\>cd C:\Program Files\Sandcastle\Examples\Sandcastle

    C:\Program Files\Sandcastle\Examples\Sandcastle>"C:\Program Files\Sandcastle\Exa
    mples\Sandcastle\build_Sandcastle.bat"

    C:\Program Files\Sandcastle\Examples\Sandcastle>REM ********** Set path for .net
     framework2.0, sandcastle,hhc,hxcomp****************************

    C:\Program Files\Sandcastle\Examples\Sandcastle>set PATH=c:\WINDOWS\Microsoft.NE
    T\Framework\v2.0.50727;C:\Program Files\Sandcastle\\ProductionTools;C:\Program F
    iles\HTML Help Workshop;C:\Program Files\Microsoft Help 2.0 SDK;D:\Microsoft Vis
    ual Studio 8\Common7\IDE;D:\Microsoft Visual Studio 8\VC\BIN;D:\Microsoft Visual
     Studio 8\Common7\Tools;D:\Microsoft Visual Studio 8\Common7\Tools\bin;D:\Micros
    oft Visual Studio 8\VC\PlatformSDK\bin;D:\Microsoft Visual Studio 8\SDK\v2.0\bin
    ;C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727;D:\Microsoft Visual Studio 8\VC\V
    CPackages;D:\OraHome_1\bin;C:\Program Files\Oracle\jre\1.1.8\bin;D:\OraHome_1\jr
    e\1.3.1\bin;D:\OraHome_1\jre\1.1.8\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS
    \System32\Wbem;C:\Program Files\Microsoft SQL Server\90\Tools\binn\;D:\Docs\Prog
    \nant-0.85\bin;C:\Program Files\Visual Studio 2005 SDK\2007.02\VisualStudioInteg
    ration\Tools\Sandcastle\ProductionTools\

    C:\Program Files\Sandcastle\Examples\Sandcastle>if exist output rmdir output /s
    /q

    C:\Program Files\Sandcastle\Examples\Sandcastle>REM ********** Compile source fi
    les ****************************

    C:\Program Files\Sandcastle\Examples\Sandcastle>csc /t:library /doc:comments.xml
     test.cs
    Microsoft (R) Visual C# 2005 Compiler version 8.00.50727.42
    pour Microsoft (R) Windows (R) 2005 Framework version 2.0.50727
    Copyright (C) Microsoft Corporation 2001-2005. Tous droits réservés.


    C:\Program Files\Sandcastle\Examples\Sandcastle>REM ********** Call MRefBuilder
    ****************************

    C:\Program Files\Sandcastle\Examples\Sandcastle>MRefBuilder test.dll /out:reflec
    tion.org
    MrefBuilder (v2.2.64000.4)
    Copyright © Microsoft 2006
    Info: Loaded 1 assemblies for reflection and 0 dependency assemblies.
    Info: Wrote information on 1 namespaces, 1 types, and 9 members

    C:\Program Files\Sandcastle\Examples\Sandcastle>REM ********** Apply Transforms
    ****************************

    C:\Program Files\Sandcastle\Examples\Sandcastle>if {} == {vs2005} (XslTransform
    /xsl:"C:\Program Files\Sandcastle\\ProductionTransforms\ApplyVSDocModel.xsl" ref
    lection.org /xsl:"C:\Program Files\Sandcastle\\ProductionTransforms\AddFriendlyF
    ilenames.xsl" /out:reflection.xml /arg:IncludeAllMembersTopic=true /arg:IncludeI
    nheritedOverloadTopics=true )  else if {} == {hana} (XslTransform /xsl:"C:\Progr
    am Files\Sandcastle\\ProductionTransforms\ApplyVSDocModel.xsl" reflection.org /x
    sl:"C:\Program Files\Sandcastle\\ProductionTransforms\AddFriendlyFilenames.xsl"
    /out:reflection.xml /arg:IncludeAllMembersTopic=false /arg:IncludeInheritedOverl
    oadTopics=true )  else (XslTransform /xsl:"C:\Program Files\Sandcastle\\Producti
    onTransforms\ApplyPrototypeDocModel.xsl" reflection.org /xsl:"C:\Program Files\S
    andcastle\\ProductionTransforms\AddGuidFilenames.xsl" /out:reflection.xml  )
    XslTransform (v2.2.64000.4)
    Copyright © Microsoft 2005-2006
    Info: Applying XSL transformation 'C:\Program Files\Sandcastle\\ProductionTransf
    orms\ApplyPrototypeDocModel.xsl'.
    Info: Applying XSL transformation 'C:\Program Files\Sandcastle\\ProductionTransf
    orms\AddGuidFilenames.xsl'.

    C:\Program Files\Sandcastle\Examples\Sandcastle>XslTransform /xsl:"C:\Program Fi
    les\Sandcastle\\ProductionTransforms\ReflectionToManifest.xsl"  reflection.xml /
    out:manifest.xml
    XslTransform (v2.2.64000.4)
    Copyright © Microsoft 2005-2006
    Info: Applying XSL transformation 'C:\Program Files\Sandcastle\\ProductionTransf
    orms\ReflectionToManifest.xsl'.

    C:\Program Files\Sandcastle\Examples\Sandcastle>call "C:\Program Files\Sandcastl
    e\\Presentation\\copyOutput.bat"
    '"C:\Program Files\Sandcastle\\Presentation\\copyOutput.bat"' n'est pas reconnu
    en tant que commande interne
    ou externe, un programme exécutable ou un fichier de commandes.

    C:\Program Files\Sandcastle\Examples\Sandcastle>REM ********** Call BuildAssembl
    er ****************************

    C:\Program Files\Sandcastle\Examples\Sandcastle>BuildAssembler /config:"C:\Progr
    am Files\Sandcastle\\Presentation\\configuration\sandcastle.config" manifest.xml

    BuildAssembler (v2.2.64000.4)
    Copyright © Microsoft 2006
    Error: The specified configuration file could not be loaded. The error message i
    s: Impossible de trouver une partie du chemin d'accès 'C:\Program Files\Sandcast
    le\Presentation\configuration\sandcastle.config'.

    C:\Program Files\Sandcastle\Examples\Sandcastle>XslTransform /xsl:"C:\Program Fi
    les\Sandcastle\\ProductionTransforms\ReflectionToChmProject.xsl" reflection.xml
    /outSurpriseutput\test.hhp
    XslTransform (v2.2.64000.4)
    Copyright © Microsoft 2005-2006
    Info: Applying XSL transformation 'C:\Program Files\Sandcastle\\ProductionTransf
    orms\ReflectionToChmProject.xsl'.
    Error: The output file 'Output\test.hhp' could not be loaded. The error is: Impo
    ssible de trouver une partie du chemin d'accès 'C:\Program Files\Sandcastle\Exam
    ples\Sandcastle\Output\test.hhp'.

    C:\Program Files\Sandcastle\Examples\Sandcastle>REM **************Generate an in
    termediate Toc file that simulates the Whidbey TOC format.

    C:\Program Files\Sandcastle\Examples\Sandcastle>if {} == {prototype} (XslTransfo
    rm /xsl:"C:\Program Files\Sandcastle\\ProductionTransforms\createPrototypetoc.xs
    l" reflection.xml /out:toc.xml  )  else (XslTransform /xsl:"C:\Program Files\San
    dcastle\\ProductionTransforms\createvstoc.xsl" reflection.xml /out:toc.xml  )
    XslTransform (v2.2.64000.4)
    Copyright © Microsoft 2005-2006
    Info: Applying XSL transformation 'C:\Program Files\Sandcastle\\ProductionTransf
    orms\createvstoc.xsl'.

    C:\Program Files\Sandcastle\Examples\Sandcastle>REM ************ Generate CHM he
    lp project ******************************

    C:\Program Files\Sandcastle\Examples\Sandcastle>XslTransform /xsl:"C:\Program Fi
    les\Sandcastle\\ProductionTransforms\TocToChmContents.xsl" toc.xml /outSurpriseutput\t
    est.hhc
    XslTransform (v2.2.64000.4)
    Copyright © Microsoft 2005-2006
    Info: Applying XSL transformation 'C:\Program Files\Sandcastle\\ProductionTransf
    orms\TocToChmContents.xsl'.
    Error: The output file 'Output\test.hhc' could not be loaded. The error is: Impo
    ssible de trouver une partie du chemin d'accès 'C:\Program Files\Sandcastle\Exam
    ples\Sandcastle\Output\test.hhc'.

    C:\Program Files\Sandcastle\Examples\Sandcastle>XslTransform /xsl:"C:\Program Fi
    les\Sandcastle\\ProductionTransforms\ReflectionToChmIndex.xsl" reflection.xml /o
    utSurpriseutput\test.hhk
    XslTransform (v2.2.64000.4)
    Copyright © Microsoft 2005-2006
    Info: Applying XSL transformation 'C:\Program Files\Sandcastle\\ProductionTransf
    orms\ReflectionToChmIndex.xsl'.
    Error: The output file 'Output\test.hhk' could not be loaded. The error is: Impo
    ssible de trouver une partie du chemin d'accès 'C:\Program Files\Sandcastle\Exam
    ples\Sandcastle\Output\test.hhk'.

    C:\Program Files\Sandcastle\Examples\Sandcastle>hhc output\test.hhp
    Unable to open output\test.hhp.
    C:\Program Files\Sandcastle\Examples\Sandcastle>cd output
    Le chemin d'accès spécifié est introuvable.

    C:\Program Files\Sandcastle\Examples\Sandcastle>cd ..

    C:\Program Files\Sandcastle\Examples>REM ************ Generate HxS help project
    **************************************

    C:\Program Files\Sandcastle\Examples>call "C:\Program Files\Sandcastle\\Presenta
    tion\Prototype\copyHavana.bat"

    C:\Program Files\Sandcastle\Examples>copy "C:\Program Files\Sandcastle\\Presenta
    tion\Prototype\hxs\test.HxC" Output
            1 fichier(s) copié(s).

    C:\Program Files\Sandcastle\Examples>copy "C:\Program Files\Sandcastle\\Presenta
    tion\Prototype\hxs\test.HxF" Output
            1 fichier(s) copié(s).

    C:\Program Files\Sandcastle\Examples>copy "C:\Program Files\Sandcastle\\Presenta
    tion\Prototype\hxs\test_A.HxK" Output
            1 fichier(s) copié(s).

    C:\Program Files\Sandcastle\Examples>copy "C:\Program Files\Sandcastle\\Presenta
    tion\Prototype\hxs\test_B.HxK" Output
            1 fichier(s) copié(s).

    C:\Program Files\Sandcastle\Examples>copy "C:\Program Files\Sandcastle\\Presenta
    tion\Prototype\hxs\test_F.HxK" Output
            1 fichier(s) copié(s).

    C:\Program Files\Sandcastle\Examples>copy "C:\Program Files\Sandcastle\\Presenta
    tion\Prototype\hxs\test_K.HxK" Output
            1 fichier(s) copié(s).

    C:\Program Files\Sandcastle\Examples>copy "C:\Program Files\Sandcastle\\Presenta
    tion\Prototype\hxs\test_N.HxK" Output
            1 fichier(s) copié(s).

    C:\Program Files\Sandcastle\Examples>copy "C:\Program Files\Sandcastle\\Presenta
    tion\Prototype\hxs\test_S.HxK" Output
            1 fichier(s) copié(s).

    C:\Program Files\Sandcastle\Examples>XslTransform /xsl:"C:\Program Files\Sandcas
    tle\\ProductionTransforms\TocToHxSContents.xsl" toc.xml /outSurpriseutput\test.HxT
    XslTransform (v2.2.64000.4)
    Copyright © Microsoft 2005-2006
    Info: Applying XSL transformation 'C:\Program Files\Sandcastle\\ProductionTransf
    orms\TocToHxSContents.xsl'.
    Error: The output file 'Output\test.HxT' could not be loaded. The error is: Impo
    ssible de trouver une partie du chemin d'accès 'C:\Program Files\Sandcastle\Exam
    ples\Output\test.HxT'.
    C:\Program Files\Sandcastle\Examples>

    Wednesday, July 18, 2007 3:31 PM

Answers

All replies

  • Hi,

     

    The example file requires that you specify the presentation type, which you have not done.

     

    Try:

     

    build_Sandcastle.bat vs2005

     

    - Dave

    Wednesday, July 18, 2007 3:42 PM
  • Thanks for your help.

    I made a test with a stupid class file.

     

    Is it normal to get this strange "^" ?

     

    Syntax part of my method, Visual C++ syntax :

     

    public:

    void TestMethod (

                               List<String^>^test

    )

     

     

     

    Wednesday, July 18, 2007 4:18 PM
  • Hi,

     

    I'm not a C++ programmer, but I think that the carat symbol has something to do with the type being defined in managed code.

     

    Are you sure that's invalid syntax?  If so, then you may have discovered a bug in the C++ syntax transformations.

     

    - Dave

    Wednesday, July 18, 2007 4:41 PM
  • The C++ compiler does generate different method signatures in certain cases.  The ones I know about relate to classes that use generics.  It adds some extra information that the C# and VB.NET compilers do not generate and this causes the methods to fail to get documented (they show up but are missing all of the summary, remarks, etc).  I added a property to the help file builder to fix up the comments in those cases so that they are documented correctly.  I just saw that in the example it is using generics and does fit the pattern of one of the failing signatures (the included "^" on the end).  The other one has a "`" followed by digits.

     

    Eric

     

    Wednesday, July 18, 2007 5:39 PM
  • thanks one last question : is there a way to disable VB.Net and C++ from the documentation ? Our applications are only in C#.
    Thursday, July 19, 2007 7:57 AM
  • Hi,

     

    Try the recommendations in these threads:

     

    Sandcastle Feedback (last post)

    http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=1375635&SiteID=1

     

    Sandcastle - How to prevent generation of C++ and VB syntax

    http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=920639&SiteID=1

     

    - Dave

    Thursday, July 19, 2007 8:00 AM