documentationjs / documentationjs/documentation

memberof does not cascade down to class members

Offen
#591 5 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
bug
Vorherrschende Sprache
JavaScript
Sterne
5.8k
Forks
481
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

With the following code:

```
/** @module module */

/**
* @class Clazz
* @memberof module
*/
class Clazz {
/** Whatever */
member = 7
}
```

The `member` member gets documented as a root-level item with `"memberof": "Clazz",`. It really should be a memberof `module.Clazz`. Adding an explicit `memberof` does allow it to generate the correct docs. This is possibly related to #417 but seems to be more an extension of the same problem. (I already think there's an open issue that @module should already imply that `Clazz` is a `memberof` `module`. If not, I'll be happy to create one)

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, das bereitgestellte JavaScript-Beispiel durch documentationjs laufen zu lassen und die generierten memberof-Werte für Clazz und member zu prüfen. Verfolge anschließend, wie @memberof von der Klasse auf ihre Mitglieder vererbt wird, und füge eine Testabdeckung hinzu, die zeigt, dass member ohne ein explizites Tag zu module.Clazz aufgelöst wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

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