home *** CD-ROM | disk | FTP | other *** search
/ C/C++ User's Journal & Wi…eveloper's Journal Tools / C-C__Users_Journal_and_Windows_Developers_Journal_Tools_1997.iso / object / data.1 / readme.txt < prev    next >
Text File  |  1996-10-27  |  3KB  |  80 lines
  1.                Welcome to Object Outline Version 1.1 beta 1
  2.  
  3.                        HTML+RTF viewers
  4.  
  5. Object Outline has been tested with the Microsoft Internet Explorer 2.0, 
  6. 3.0 and Netscape navigator 2.02.  It does not work with the AOL 2.5 WWW 
  7. browser because AOL does not support HTML 3.0 tables.  The AOL 3.0
  8. browser should work fine.  Other browsers that support tables should work 
  9. fine.  The RTF files have been tested in MS-Word 6.0 and 7.0 only. As 
  10. noted above, WordPad will not work because it does not support RTF 
  11. tables, RTF sections, and page breaks.
  12.  
  13.                  New Features in this beta
  14.  
  15. 1.  Auto layout - Allows quick configuration of large projects with
  16.     many header files.
  17. 2.  HTML split view file generation.
  18. 3.  Virtual function tracing - marks functions as virtual even if
  19.     they are not marked as virtual in the class declaration.
  20. 4.  Can place C functions in the table of contents (HTML only)
  21. 5.  McCabe complexity metric.
  22. 6.  Object Outline can now hyperlink through typedefs.
  23. 7.  50% speed improvements for large systems.
  24.  
  25.                        Known problems
  26.  
  27. 1. Functions that are prototyped in a friend declaration are not
  28.    handled correctly.
  29.  
  30. example:
  31.    class A { friend void Foo(); }
  32.    inline void Foo() {}
  33.  
  34. 2. Functions and member functions that use typedefs inconsistently will
  35.    not be parsed correctly.  The HP STL rb_tree template does this in several 
  36.    functions.  Object Outline will complain that function foo was not found.
  37.  
  38. example:
  39.    typedef short INT16;
  40.    void foo::foo(const INT16);
  41.    void foo::foo(const short x) {}
  42.  
  43. 3. Specialized templates without generic declarations are not documented, they
  44.    are ignored.  Object Outline will complain that class foo is not defined.
  45.  
  46. example:
  47.    template <class T> class foo;
  48.    class foo<int> { ... }
  49.  
  50. 4. Unions are not documented and are ignored.
  51.  
  52. 5. Static classes member functions cause a incorrect error.  Such classes
  53.    should not be documented, so the error can be ignored.
  54.  
  55. example:
  56.   static class foo { public: foo(); ~foo(); } init;
  57.   foo::foo() {}
  58.  
  59. 6. Member functions that take function pointers as arguments are not
  60.    parsed correctly and may be reported as a missing function.
  61.  
  62. example
  63.   class foo { public: foo(unsigned int (* hashFun )() ) };
  64.   foo::foo(unsigned int (*hashFundifferent)()) {}
  65.  
  66. 7. Member functions that take sized arrays for parameters are not
  67.    parsed correctly and may be reported as a missing function.
  68.  
  69. example:
  70.   class foo { public: foo(int x[100]); }; foo::foo(int y[100]) {}
  71.  
  72. 8. Different classes with the same name are not documented correctly.
  73.  
  74. Please report all other problems to support@bbeesoft.com.
  75.  
  76.             Change Log
  77.  
  78. October 27,1996 - 1.10 beta 1 released.
  79.  
  80.