Skip to content

Feature: Add EXTERNAL_NAMESPACES configuration option, or similar #10234

Closed
@oblivioncth

Description

@oblivioncth

I initially requested that external namespaces from tags not appear in the namespace index, at least by default, with #9241 which was actioned on. Later, in 1.9.6 the entries returned, albeit with an appropriate "[external]" designation. It appears (as kindly pointed out by @albert-github) that this was due to the work for #9602.

I can understand why some might want these namespaces to appear in the index in certain circumstances, like when the tags in question belong to related projects, particularly those also controlled by the same author; however, in my case I am only using tags to link to Qt documentation, which of course is a well known project with its own documentation that can easily be perused independently and so I don't want its namespaces (which often aren't even used directly in user code) appearing in my documentation.

Expected behavior
Given we already have configurations like:

  • EXTERNAL_GROUPS
  • EXTERNAL_PAGES

which affect the presence of other entities in their respective indices of the current project, I figure it would be reasonable to also have an option (i.e. EXTERNAL_NAMESPACES) that also controls whether or not external namespaces appear in the index.

Ultimately, I think user's should be able to control whether or not namespaces from tags appear here in one way or another, regardless of the particular method.

Screenshots
image

To Reproduce
Use any project with tags that have documented namepsaces. If a sample project is needed, the one form #9241 should still suffice.

Version
1.9.7

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions