0

Public enum(excluded or not) in excluded class results in help entries of the class

Stefan H.

31 August 2007 03:38

None

Follow

Hi,

we have this problem with Document!X Version 4 and Document!X Version 5 (currently we have eval version only).

Description:

I want to document the interface of my vb6 project. In it the is a cls file with an Public Enum and a class which can be  be private or public.

I create a new Document!X project with this vbp and then i use the included modules filter to uncheck the class and the enum in it.

After building the help everything seems ok in the Content and Index nothing from the excluded class is found. But if search in the chm for the name of the excluded class i will find everything in it.

I need an easy solution (fixed build of Document!X or workaround) for this issue. I've tried to exclude all features but with this 2 entries remain in the help: the overview of the class and the members entry. Then I tried a conditional generation setting of these 2 entries in the page layouts of the template editor(module, module_members). But I have classes with properties only and other with methods only. It doesn't seem to be possible to define a condition "if atleast one property or one method". Right? All these is of course too much complicated for me. So I need a easier solution.

Any help welcome.

Regards, Stefan Hoffmann

• Facebook
• Twitter
• LinkedIn

4 comments

• 0
  
  Stefan H. 03 September 2007 04:34

  The problem exists for all source files (also for forms, user controls and modules) with a public enum or public type.

  Stefan

• 0
  
  Permanently deleted user 04 September 2007 07:37

  This behavior is by design - if any of the members of your other project modules use the enumeration (e.g. in a return type or parameter), then Document! X will automatically output documentation for it (so that the enum values are documented).

• 0
  
  Stefan H. 04 September 2007 10:05

  Richard, did you understand me?

  I will try to describe it again:

  • I have a class with some properties and an enum in together in a class file of a vb6 project. The enum is never used anywhere.
  • In the corresponding Document!X project the class and the enum are unchecked in the Include Modules settings.
  • After a build the TOC is as i expect but when doing a search in the chm this happens:
  • No results for the name of the enum
  • If i search for the name of the class all properties and an overview and members list is found for this class which should not be included!

  You wrote that the enum is documented. No that is not my problem and it is wrong. The enum is not documented because i configured the project to exclude it! The class is documented although i also excluded it.

  Rethink about it. I don't believe this can be design. Of course i can give you a sample project (vb and dxp). But it is easy to build your own if you read my posting.

  Stefan

• 0
  
  Permanently deleted user 05 September 2007 03:23

  Sorry for any confusion caused. Can you please try deleting the Document! X output directory and rebuilding. If that doesn't cure the problem, could you please send a copy of your project and .dxp to support@innovasys.com - I could not reproduce the problem with a test project containing the arrangement you describe (a class file containing an enum and a class - both excluded from the 'Included Modules' page) - in my test both the class and enum do not appear in the output.