API Filter Issues
This topic covers common questions and issues related to the API Filter.
- I used the Namespace Summaries project option to exclude a namespace but it is still showing up in the help file. Why?
- I used the <exclude /> tag feature to exclude a namespace/type/member but it is still showing up in the help file. Why?
- I used the Namespace Summaries project option to exclude a namespace. I now want it included but it is not showing up. Why?
- I used the <exclude /> tag to exclude a namespace/type/member. I removed the tag as I now want it included but it is not showing up. Why?
- Why does the API filter uncheck/check the parent namespace/type if I uncheck/check more than half of the types/members?
I used the Namespace Summaries project option to exclude a namespace but it is still showing up in the help file. Why?
Check the build log in the section where it generated the API filter. You will probably see a warning there about the exclusion conflicting with the API filter. The API filter always wins. To fix the issue, edit the API Filter project property and exclude the item there.
I used the <exclude /> tag feature to exclude a namespace/type/member but it is still showing up in the help file. Why?
See the answer to the previous question.
I used the Namespace Summaries project option to exclude a namespace. I now want it included but it is not showing up. Why?
Check the API Filter project property as it is probably being excluded in there. This situation does not generate a warning in the log so you have to check for it manually. Simply place a checkmark next to the item you want to have included.
I used the <exclude /> tag to exclude a namespace/type/member. I removed the tag as I now want it included but it is not showing up. Why?
See the answer to the previous question.
Why does the API filter uncheck/check the parent namespace/type if I uncheck/check more than half of the types/members?
This behavior is by design. See the Including and Excluding Members section of the API Filter Property help topic. It is done to create a more efficient filter. If more than half of the members are omitted, the parent is written out as an exclude entry with child entries just for those marked for inclusion. If more than half are included, the opposite occurs. Building the help file will result in the proper members being included or excluded. If you think you are seeing incorrect behavior with regard to the resulting help file, please supply an example that demonstrates the problem.