As was foretold, we've added advertisements to the forums! If you have questions, or if you encounter any bugs, please visit this thread: https://forums.penny-arcade.com/discussion/240191/forum-advertisement-faq-and-reports-thread/
Options

Generate API Documentation [lock]

bowenbowen How you doin'?Registered User regular
edited March 2010 in Help / Advice Forum
Does anyone have a good utility or program that will generate API functionality from .NET's block comments?

I'm looking for something similar to the JAVA's API libraries online.

ie) http://java.sun.com/j2se/1.4.2/docs/api/

For more information, the block comments look like this:
        /// <summary>
        /// Send Encoding.UTF8 byte[] array to the remote endpoint
        /// </summary>
        /// <param name="Data">Encoding.UTF8 byte[]</param>
        public void Send(byte[] Data) ...

not a doctor, not a lawyer, examples I use may not be fully researched so don't take out of context plz, don't @ me
bowen on

Posts

  • Options
    bowenbowen How you doin'? Registered User regular
    edited March 2010
    I've found basically what I'm looking for, so for others that need this, here you go:

    http://bloggingabout.net/blogs/jschreuder/archive/2007/03/20/using-sandcastle-is-increasingly-mature.aspx

    You can use this to generate "website" style too.

    bowen on
    not a doctor, not a lawyer, examples I use may not be fully researched so don't take out of context plz, don't @ me
  • Options
    GanluanGanluan Registered User regular
    edited March 2010
    FYI Sandcastle is a bit rough around the edges. I use DocProject (I think it's on CodePlex), which is basically a nice GUI for Sandcastle that you can use like any other .NET project. You can incorporate your documentation directly into the solution that way, which is nice.

    Ganluan on
  • Options
    bowenbowen How you doin'? Registered User regular
    edited March 2010
    Thanks Ganluan, I'll check that out too.

    bowen on
    not a doctor, not a lawyer, examples I use may not be fully researched so don't take out of context plz, don't @ me
Sign In or Register to comment.