documentationjs / documentationjs/documentation

Instance members of objects within a namespace not in correct section

Aperta
#684 5 commenti 2 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
JavaScript
Stelle
5.8k
Fork
481
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

It seems as though instance members of a class/object within a namespace are not organized correctly on the output documentation. I am running the very latest commit to date: https://github.com/documentationjs/documentation/commit/f07285a9200162908efa5dfc3076cb32d1425c6e

See example below:

```javascript
/**
* A namespace.
* @namespace MyNamespace
*/

/**
* This class has an issue since it is in a namespace
* @class FooClass
* @memberof MyNamespace
*/
class FooClass {
/**
* Function description for foo
*/
bar() {}
}

/**
* This class has no issue as it is not in a namespace
* @class BarClass
*/
class BarClass {
/**
* Function description for foo
*/
baz() {}
}
```

HTML Output:
![image](https://cloud.githubusercontent.com/assets/5579960/23447546/b41c000c-fe19-11e6-8844-2716a8c6bc80.png)

Notice how the `bar` function is not nested under its class of `FooClass`. I would expect it would be nested within the `FooClass` member of the `MyNamespace` namespace

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Riproduci l’issue 684 con l’esempio di namespace e classe JavaScript, quindi esamina l’HTML generato per tracciare dove vengono posizionati FooClass e il suo membro bar. Il lavoro è completato quando bar è annidato sotto FooClass nella sezione MyNamespace, in conformità con l’output previsto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript
Ambito
documentation
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
38/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.