Results 1 to 7 of 7

Thread: [RESOLVED] [2005] Documentation

  1. #1

    Thread Starter
    Addicted Member
    Join Date
    Sep 2008
    Location
    Jacksonville, Florida
    Posts
    147

    Resolved [RESOLVED] [2005] Documentation

    Does anyone know of any tools that you can point at a project or the xml generated with its DLL to build you a template for documenting the project?

    If not I'm thinking of trying to read the XML into a tree view, since the +/- buttons to expand and contract detail on something would be tremendously helpful for large libraries. The other thing I was considering was an XSLT to lay on top of a webpage.

    I'm ok with XML, but not great with utilizing it in VB, so this would be good practice/learning.

    Thoughts?

  2. #2
    PowerPoster gep13's Avatar
    Join Date
    Nov 2004
    Location
    The Granite City
    Posts
    21,963

    Re: [2005] Documentation

    Hey,

    Unless I have misunderstood your request, you might want to look at the following:

    Sandcastle
    NDoc

    Hope this helps!!

    Gary

  3. #3

    Thread Starter
    Addicted Member
    Join Date
    Sep 2008
    Location
    Jacksonville, Florida
    Posts
    147

    Re: [2005] Documentation

    both of those look like a fairly good solution, however NDoc just throws exceptions as it doesn't support .net 2.0 or newer. trying sandcastle now.

  4. #4

    Thread Starter
    Addicted Member
    Join Date
    Sep 2008
    Location
    Jacksonville, Florida
    Posts
    147

    Re: [2005] Documentation

    Sandcastle Error: SyntaxComponent: The type 'Microsoft.Ddue.Tools.ScriptSharpDeclarationSyntaxGenerator' does not exist in the assembly 'C:\Program Files\Visual Studio 2005 SDK\2007.02\VisualStudioIntegration\Tools\Sandcastle\\ProductionTools\SyntaxComponents.dll'.
    This is almost the last step the buildAssembler step.

  5. #5

    Thread Starter
    Addicted Member
    Join Date
    Sep 2008
    Location
    Jacksonville, Florida
    Posts
    147

    Resolved Re: [2005] Documentation

    Thanks to the nicely informative error messages and FAQ in Sandcastle Help File Builder, it appears I have auto-built documentation for my biggest library in 3 different formats. My boss is satisfied, I don't have to write manual documentation, WEEEEE.

  6. #6

  7. #7

    Thread Starter
    Addicted Member
    Join Date
    Sep 2008
    Location
    Jacksonville, Florida
    Posts
    147

    Resolved Re: [RESOLVED] [2005] Documentation

    Marked resolved, and rated. thanks.

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  



Click Here to Expand Forum to Full Width