back to software
up to home

Download GenCIDocs.py - XPCOM Component Interface HTML Reference Generator


Download

Download GenCIDocs.py.

 Version 0.8, 23-Feb-2001

 17,926 bytes


About

 GenCIDocs.py
 XPCOM Component Interface HTML Reference
 Generator

 Version 0.8, 23-Feb-2001

 About:
  Generates html documentation for
  all registered XPCOM components
  and interfaces.

 Requirements:
  Requires PyXPCOM
  http://www.activestate.com/Products/Komodo/PyXPCOM/
  Tested on WinNT4 but should work everywhere
  where PyXPCOM works.

 Usage:
  Takes no parameters. Execute
  directly to produce all html
  docs in current directory

  Warning: Built incrementally 
 with focus only on getting results
 (read as: dirty code and bad design,
 but copyright anyway :-)

 Todo:
  - Templatize html generation so
    style of produced html pages
    can be easily changed
  - Generate docs only for a specified
    set of interfaces and/or components
  - Think about producing XML instead
  - Also generate a frames version
  - Give more info in generated docs:
    - library filename (.dll or .so)
      containing a component
    - typelib filename (.xpt) contaning
      an interface definition

 Copyright (c) 2001, Shalabh Chaturvedi

 Released under the MPLv1.1
 http://www.mozilla.org/MPL/MPL-1.1.html