locked
Question about how to get the description of Namespace

    Question

  • I want to get the description of Namespace,like MSDN,but i don't know which tags can function it,or how can do...
    Tuesday, August 29, 2006 9:28 AM

Answers

  • To solve this problem I've created a separate xml file "ProjectComments.xml" with content like this:

    <?xml version="1.0"?>
    <doc>
     <members>
      <member name="R:Project">
       <summary>About the project.</summary>
      </member>
      <member name="N:Namespace_1">
       <summary>
        About Namespace_1.
       </summary>
      </member>
      <member name="N:Namespace_2">
       <summary>
        About Namespace_2.
       </summary>
      </member>
     </members>
    </doc>

    This file can stand separately and just be listed as another documentation file.

    Karlo

     

    Tuesday, September 05, 2006 6:52 PM

All replies

  • Hello Jason - can you give us a little more information about what you're trying to accomplish? I don't have enough of a context to understand what you're trying to do. Thanks!

    Tuesday, August 29, 2006 5:47 PM
  • If it is for Sandcastle you can do the following. CSC, I believe, does not allow description at the project, namespace level.

    Open your xml comments file and add the following comments for R: and N:. I have colored them red below. By adding summaer for R: and N: you will get the description at the project and namespace level.

    <?xml version="1.0"?>
    <doc>
        <assembly>
            <name>foo</name>
        </assembly>
        <members>
     <member name="R:Project">
                <summary>
                This is the project summary
                </summary>
            </member>
     <member name="N:foo">
                <summary>
                This is the NS summary
                </summary>
            </member>
    </members>
    </doc>

     Anand..

    Tuesday, August 29, 2006 6:55 PM
  • Thanks,

    But if i need build my solution many times and every time i need to generate the document,use this method i must to modify my command xml file every time by hand,it's to hard,and if it exist an easy method ,or if the next version supply an auto-method,not hand by hand like this

    best regards

    Saturday, September 02, 2006 8:12 AM
  • Instead of doing it by hand, you could merge in the extra information using xsl.
    Monday, September 04, 2006 2:21 PM
  • Sandcastle allows multiple comment xml files. You can create a seperate file for root and namespace description and pass them.

    Sandcastle FAQ at http://blogs.msdn.com/sandcastle/archive/2006/07/30/683352.aspx [rpvodes information about how to pass multiple authored xml comments file.

     

    Anand..

     

    Tuesday, September 05, 2006 5:34 PM
  • To solve this problem I've created a separate xml file "ProjectComments.xml" with content like this:

    <?xml version="1.0"?>
    <doc>
     <members>
      <member name="R:Project">
       <summary>About the project.</summary>
      </member>
      <member name="N:Namespace_1">
       <summary>
        About Namespace_1.
       </summary>
      </member>
      <member name="N:Namespace_2">
       <summary>
        About Namespace_2.
       </summary>
      </member>
     </members>
    </doc>

    This file can stand separately and just be listed as another documentation file.

    Karlo

     

    Tuesday, September 05, 2006 6:52 PM
  • Thanks,Anand

    Thanks,Karlo

    Wednesday, September 06, 2006 4:26 AM