dignifiedquire / dignifiedquire/clean-documentation-theme

Object Properties Missing

Open
#16 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
19
Forks
5
PR merge metrics
No merged PRs in 30d

Description

See [this stackoverflow question](https://stackoverflow.com/questions/53490045/how-to-document-an-object-within-a-class-constructor/53490618#53490618) for more details.

When making an object in a class, the properties for the object do not show up.

Example Object
```js
/**
* The URLs for the ads attributed to this song.
* @typedef AdUrls
* @property {String} flexSkip The ad used if the user wants to gain more skips.
* @property {String} flexReplay The ad used if the user wants to gain more replays.
* @property {String} flexThumbsDown The ad used if the user wants to skip using a thumbs down.
* @property {String} nowPlayingStation The ad used for now playing songs.
* @property {String} nowPlayingStationAdUnit The nowplaying ad unit. (?)
* @property {String} nowPlayingStationAdTargeting The nowplaying ad 'targeting'. (?)
* @property {String} backstage The "backstage" ad. (?)
* @property {String} backstageAdUnit The "backstage" ad unit. (?)
* @property {String} backstageAdTargeting The "backstage" ad targeting. (?)
*/
this.adUrls = {
flexSkip: raw.adUrls.flexSkipAdUrl,
flexReplay: raw.adUrls.flexSkipAdUrl,
flexThumbsDown: raw.adUrls.flexThumbsDownAdUrl,
nowPlayingStation: raw.adUrls.nowPlayingStationAdUrl,
nowPlayingStationAdUnit: raw.adUrls.nowPlayingStationAdUnit,
nowPlayingStationAdTargeting: raw.adUrls.nowPlayingStationAdTargeting,
backstage: raw.adUrls.backstageAdUrl,
backstageAdUnit: raw.adUrls.backstageAdUnit,
backstageAdTargeting: raw.adUrls.backstageAdTargeting
};
```

Using default theme:
![chrome_2018-11-26_16-29-05](https://user-images.githubusercontent.com/16494272/49048554-6664b880-f198-11e8-83be-c93bae2429f1.jpg)

Using this theme:
![chrome_2018-11-26_16-28-39](https://user-images.githubusercontent.com/16494272/49048536-55b44280-f198-11e8-9c87-6b90bdc9acb6.jpg)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.