docs: fix the TypeDoc warnings and hide the protected internals of NetworkServerLibrary

Offen
  • Stimmt etwas nicht?
#468 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
55/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
typescript
Bereich
documentation

Rechercherichtung

Start by reading typedoc.json and the TypeDoc output from pnpm run docs; the issue names affected APIs across core, ecs, network server, and scene, plus server.network.base.ts. Review the unresolved links and unexported referenced types, then check how protected members are documented. Done when the command reports no warnings and the generated NetworkServerLibrary reference hides the listed protected internals.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation modules:network
What is the type of issue?

Documentation is incorrect, Documentation is missing

What is the issue?

pnpm run docs (TypeDoc, branch feat/docs-navigation) ends with 0 errors and 14 warnings, and publishes some implementation details:

  • NetworkServerLibrary documents its protected fields _registry, _server and _trace (https://github.com/NanoForge-dev/Engine/blob/0470c096970747dbf5774420f0ca1b4d47f2927f/modules/network/src/server/server.network.base.ts#L18-L20). typedoc.json sets excludePrivate but not excludeProtected; library authors may need the protected members of Library, so marking these @internal is probably the right fix.
  • Types referenced by public APIs but not exported: NanoforgeFactoryStatic, InternalViewportState (core); ECSElement, ClassHandle (ecs); ClientRegistry, NetworkServer, Trace (network server); SceneVarsStore, AnyScene, AnySceneClass (scene).
  • An unresolved {@link NfDuplicateLibraryException} in NanoforgeClient.use and NanoforgeServer.use (core).
  • UDPServerIceConfig links to UDPServer, which isn't documented.

Expected: pnpm run docs with no warning, and no _ internals in the reference.

Where did you find it?

Output of pnpm run docs on branch feat/docs-navigation; page references/engine/<version>/network/server/classes/NetworkServerLibrary of the generated reference.

Vorherrschende Sprache
TypeScript
Sterne
7
Forks
2
Ø Merge
1 T. 17 Std.
Gemergte PRs (30 T.)
17

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus NanoForge-dev/Engine

Alle Issues in NanoForge-dev/Engine

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.