[ISSUE][DOCS] Missing API reference

Open
#5 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp
Domain
documentation

Research direction

Review the impacted API reference page, class_az_framework_1_1_spawnable_1_1_entity_alias_visitor_base.html, and the linked o3de.org pull request first. Investigate how Doxygen handles private and protected documentation dependencies. Done means the API reference includes the required public, protected, friend, and private base classes without breaking existing links.

Written by the indexing model from the issue text.

Description

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 https://github.com/o3de/o3de.org/pull/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
Dominant language
HTML
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.