Women in Technology

Hear us Roar



Article:
  Using NDoc: Adding World-Class Documentation to Your .NET Components
Subject:   Performance
Date:   2003-07-17 12:14:28
From:   anonymous2
Hi,


I am attempting to document a rather large project (the xml doc created by the compiler is 3 meg). Ndocs takes about 3 hours to run, and swallows a large amount of memory (somewhere north of 200 meg). It ends up creating over 26,000 files (html and such), and I get an error that 'the compile (of the HTML help file) was aborted' because it did not complete after 10 minutes. Despite this message the resultant .chm file looks complete (obviously I can not be 100% certain that every doc page is present), and it finishes at around 10 meg. After all this descrition, I am simply wondering if there is any way to improve performance (i.e. allocate more space, speed up compilation, etc.). Thanks for the article and the help.


-Sri

Full Threads Oldest First

Showing messages 1 through 1 of 1.

  • Performance
    2003-07-17 12:41:54  arithex [View]

    Wow. 26000? 26000 namespaces, types, and members...!? I haven't checked, but my intuition is that's much larger than the entire .NET Framework.

    By my math, if you'd started coding this monstrosity sometime during the early .NET betas, you'd have authored an average of 20 to 30 new types/members, each day (including weekends and holidays). And with full documentation... bully job!

    Sarcasm aside -- can I take it this is some kind of autogenerated API? You may wish to skip NDoc, and generate the .html files yourself, at the same time (and in the same manner?) you're generating the actual code.

    What happens if you try to compile the intermediate results of NDoc into a CHM file manually, using HHC.exe? Does it still complain about the 10 min. timeout?

    (The command line syntax of HHC.exe is trivial -- just point it at the HHP file emitted by NDoc.)

    Good luck,
    -S