SubMain - CodeIt.Right The First Time!


Support Community for SubMain Products
 Home Products Services Download Purchase Support
in Search
Home Forums Blogs Tutorials/CIR Tutorials/GD Downloads
Welcome to SubMain Community Sign in | Join | Help

How do I create a contents page

Last post 03-10-2018, 10:09 AM by techtoniq. 2 replies.
Sort Posts: Previous Next
  •  03-10-2018, 5:43 AM 5088

    How do I create a contents page

    Hi, apologies for the newbie question but I'm struggling to figure out how to get a contents page generated for my C# solution.


    My solution contains three projects - A, B and C. When I build the documentation, the index.html page gives me a contents panel on the left listing the three assembleys A, B and C, with the documentation for assembley A selected and the classes page for assembley A  on the right.

    What I would like to have is the right hand page showing an overall contents page listing the assembleys A, B and C with a description of what they are.

    I've figured out that if I put XML comments above the namespace declaration in one of the files in each of the assembleys that at least creates the comment for the assembley but I can't figure out how to configure Ghostdoc to generate an "overall" contents page and have that displayed as the default page when I open index.html.

    Any help much appreciated. 

  •  03-10-2018, 9:21 AM 5089 in reply to 5088

    Re: How do I create a contents page

    Please take a look at this tutorial and let me know if that is what you are looking for - 

    Conceptual Content - Adding Custom Content to API Documentation created with GhostDoc


    Thank you,
    Serge Baranovsky - .NET Developer Tools  |  Microsoft MVP  |  ASP Insider
    » » CodeIt.Right Will Fix Your Code!™ -
    » » C#/VB .NET Coding Guidelines - FREE 100+ page ebook (PDF)
  •  03-10-2018, 10:09 AM 5090 in reply to 5089

    Re: How do I create a contents page

    Thanks for the quick response, that looks promising I shall give it a trial.
View as RSS news feed in XML
Home |  Products |  Services |  Download |  Purchase |  Support |  Community |  About Us |