Announcement

Collapse
No announcement yet.

source code documentation party!

Collapse
This is a sticky topic.
X
X
  • Filter
  • Time
  • Show
Clear All
new posts

  • source code documentation party!

    I'm forever trying to get into the code to mess around, but I'd like some documentation to help me along so I don't have to bother the forums or the irc channel, so I'd like to propose a source-code documentation party!

    Going through the source, if people could document the public methods, it'd not only help noobs like myself, but also help with producing automated MSDN docs (sandcastle, etc).

    What do people think?

  • #2
    It might be helpful to run one of the automatic doc tools on the source first to see what is missing (or what is missing the most). Then those of us who have already untangled something that is undocumented can try to fill in the blanks.

    Comment


    • #3
      Originally posted by withak View Post
      It might be helpful to run one of the automatic doc tools on the source first to see what is missing (or what is missing the most). Then those of us who have already untangled something that is undocumented can try to fill in the blanks.
      first pass run of doxygen on the current svn revision (3763) is available. more to come as i get orcas/sandcastle up.

      - h

      Comment


      • #4
        So does "Summary description of X" count as documentation?

        Comment


        • #5
          Originally posted by withak View Post
          So does "Summary description of X" count as documentation?
          welcome to the party, my friend

          Comment


          • #6
            /me is willing to elaborate on any installer doc needed, I've got a pretty good understanding of it now
            Note: The above statement is probably an educated guess, derived from much forum reading, IRC chatting, general curiosity, etc. Use at your own risk.
            Before asking, check the FAQ or search, and Ask a good question.

            Having problems? Make sure you have Managed DirectX and .NET Framework.
            Then check the Video Card Compatibility List


            Comment


            • #7
              How to join in??

              Originally posted by ghchinoy View Post
              I'm forever trying to get into the code to mess around, but I'd like some documentation to help me along so I don't have to bother the forums or the irc channel, so I'd like to propose a source-code documentation party!

              Going through the source, if people could document the public methods, it'd not only help noobs like myself, but also help with producing automated MSDN docs (sandcastle, etc).

              What do people think?
              Who organise the party??
              If the party exist, how can I join in??

              Comment

              Working...
              X