Skip to content

[ISSUE][DOCS] Missing API reference #5

@sptramer

Description

@sptramer

Describe the issue

Some API reference appears to be missing due to relying on a private base class which isn't exposed in the docs generation (see o3de/o3de.org#2009). Doxygen does not have an easy mechanism for detecting docs dependencies like this; You can either publish everything from private or nothing from private (same with protected). This isn't quite a misfeature of Doxygen but requires further investigation.

Impacted page(s)

Any page linking to class_az_framework_1_1_spawnable_1_1_entity_alias_visitor_base.html in the API reference and the documentation for this class itself.

Expected experience

API ref is comprehensive for:

  • Public classes
  • protected and friend classes which are used for base classes or virtual function dispatch
  • private classes which are used as base classes for public or protected classes

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    In progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions