Skip to content

Commit

Permalink
[DOC release] Fix API doc issues with package split. (#6280)
Browse files Browse the repository at this point in the history
* [DOC release] Remove @for DS

* [DOC release] Add @module declaration to each package file.

* [DOC release] Remove @namespace DS usage.

* [DOC release] Remove @namespace usage.
  • Loading branch information
rwjblue authored and runspired committed Jul 25, 2019
1 parent aa2c0d5 commit 63e13ba
Show file tree
Hide file tree
Showing 91 changed files with 346 additions and 83 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import Model from '@ember-data/model';
Extend `Ember.DataAdapter` with ED specific code.
@class DebugAdapter
@namespace DS
@extends Ember.DataAdapter
@private
*/
Expand Down
5 changes: 4 additions & 1 deletion packages/adapter/addon/-private/build-url-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ import Mixin from '@ember/object/mixin';
import { get } from '@ember/object';
import { pluralize } from 'ember-inflector';

/**
@module @ember-data/adapter
*/

/**
WARNING: This interface is likely to change in order to accommodate [RFC: Ember Data url templates](https://github.com/emberjs/rfcs/pull/4)
Expand Down Expand Up @@ -30,7 +34,6 @@ import { pluralize } from 'ember-inflector';
The `host` and `namespace` attributes will be used if defined, and are optional.
@class BuildURLMixin
@namespace DS
*/
export default Mixin.create({
/**
Expand Down
4 changes: 4 additions & 0 deletions packages/adapter/addon/-private/index.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
@module @ember-data/adapter
*/

export { default as parseResponseHeaders } from './utils/parse-response-headers';
export { determineBodyPromise } from './utils/determine-body-promise';
export { serializeQueryParams } from './utils/serialize-query-params';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/**
/*
* Function that always attempts to parse the response as json, and if an error is thrown,
* returns `undefined` if the response is successful and has a status code of 204 (No Content),
* or 205 (Reset Content) or if the request method was 'HEAD', and the plain payload otherwise.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ function isPlainObject(obj: any): boolean {
return Object.prototype.toString.call(obj) === '[object Object]';
}

/**
/*
* Helper function that turns the data/body of a request into a query param string.
* This is directly copied from jQuery.param.
*/
Expand Down Expand Up @@ -52,7 +52,7 @@ export function serializeQueryParams(
.replace(/%20/g, '+');
}

/**
/*
* Part of the `serializeQueryParams` helper function.
*/
function add(s: Array<any>, k: string, v?: string | (() => string)) {
Expand Down
3 changes: 1 addition & 2 deletions packages/adapter/addon/adapter.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
@module ember-data
@module @ember-data/adapter
*/

import EmberObject from '@ember/object';
Expand Down Expand Up @@ -56,7 +56,6 @@ import EmberObject from '@ember/object';
included REST adapter.
@class Adapter
@namespace DS
@extends EmberObject
*/

Expand Down
4 changes: 4 additions & 0 deletions packages/adapter/addon/error.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import EmberError from '@ember/error';
import { assert } from '@ember/debug';

/**
@module @ember-data/adapter
*/

/**
A `AdapterError` is used by an adapter to signal that an error occurred
during a request to an external API. It indicates a generic error, and
Expand Down
4 changes: 4 additions & 0 deletions packages/adapter/addon/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
/**
@module @ember-data/adapter
*/

export { BuildURLMixin } from './-private';
export { default } from './adapter';
5 changes: 2 additions & 3 deletions packages/adapter/addon/json-api.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
@module ember-data
@module @ember-data/adapter
*/
import { dasherize } from '@ember/string';
import RESTAdapter from './rest';
Expand Down Expand Up @@ -138,8 +138,7 @@ import { pluralize } from 'ember-inflector';
@since 1.13.0
@class JSONAPIAdapter
@constructor
@namespace DS
@extends DS.RESTAdapter
@extends RESTAdapter
*/
const JSONAPIAdapter = RESTAdapter.extend({
defaultSerializer: '-json-api',
Expand Down
8 changes: 4 additions & 4 deletions packages/adapter/addon/rest.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/* globals najax jQuery */

/**
@module ember-data
@module @ember-data/adapter
*/

import RSVP, { Promise as EmberPromise } from 'rsvp';
Expand Down Expand Up @@ -285,9 +286,8 @@ const hasNajax = typeof najax !== 'undefined';
@class RESTAdapter
@constructor
@namespace DS
@extends DS.Adapter
@uses DS.BuildURLMixin
@extends Adapter
@uses BuildURLMixin
*/
const RESTAdapter = Adapter.extend(BuildURLMixin, {
defaultSerializer: '-rest',
Expand Down
4 changes: 4 additions & 0 deletions packages/canary-features/addon/default-features.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
@module @ember-data/canary-features
*/

/*
This list of features is used both at build time (by `@ember-data/-build-infra`)
and at runtime (by `@ember-data/canary-features`).
Expand Down
4 changes: 4 additions & 0 deletions packages/canary-features/addon/index.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
/* globals EmberDataENV */

/**
@module @ember-data/canary-features
*/

import { assign } from '@ember/polyfills';
import DEFAULT_FEATURES from './default-features';

Expand Down
4 changes: 1 addition & 3 deletions packages/model/addon/-private/attr.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { recordDataFor } from '@ember-data/store/-private';
import { RECORD_DATA_ERRORS } from '@ember-data/canary-features';

/**
@module ember-data
@module @ember-data/model
*/

function getDefaultValue(record, options, key) {
Expand Down Expand Up @@ -102,9 +102,7 @@ function hasValue(internalModel, key) {
})
```
@namespace
@method attr
@for DS
@param {String|Object} type the attribute type
@param {Object} options a hash of options
@return {Attribute}
Expand Down
4 changes: 4 additions & 0 deletions packages/model/addon/-private/belongs-to.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ import { assert, warn, inspect } from '@ember/debug';
import { normalizeModelName } from '@ember-data/store';
import { DEBUG } from '@glimmer/env';

/**
@module @ember-data/model
*/

/**
`belongsTo` is used to define One-To-One and One-To-Many
relationships on a [Model](/api/data/classes/DS.Model.html).
Expand Down
4 changes: 1 addition & 3 deletions packages/model/addon/-private/has-many.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
@module ember-data
@module @ember-data/model
*/
import { computed } from '@ember/object';
import { assert, inspect } from '@ember/debug';
Expand Down Expand Up @@ -136,9 +136,7 @@ import { DEBUG } from '@glimmer/env';
If you are using `links` with sync relationships, you have to use
`ref.reload` to fetch the resources.
@namespace
@method hasMany
@for DS
@param {String} type (optional) type of the relationship
@param {Object} options (optional) a hash of options
@return {Ember.computed} relationship
Expand Down
4 changes: 4 additions & 0 deletions packages/model/addon/-private/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
@module @ember-data/model
*/

export { default as attr } from './attr';
export { default as belongsTo } from './belongs-to';
export { default as hasMany } from './has-many';
4 changes: 4 additions & 0 deletions packages/model/addon/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
/**
@module @ember-data/model
*/

export { attr, belongsTo, hasMany } from './-private';
export { Model as default } from '@ember-data/store/-private';
5 changes: 4 additions & 1 deletion packages/serializer/addon/-private/embedded-records-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ import { camelize } from '@ember/string';
import { set, get } from '@ember/object';
import { warn } from '@ember/debug';

/**
@module @ember-data/serializer
*/

/**
## Using Embedded Records
Expand Down Expand Up @@ -95,7 +99,6 @@ import { warn } from '@ember/debug';
* [serializeHasMany](/api/data/classes/DS.EmbeddedRecordsMixin.html#method_serializeHasMany)
@class EmbeddedRecordsMixin
@namespace DS
*/
export default Mixin.create({
/**
Expand Down
4 changes: 4 additions & 0 deletions packages/serializer/addon/-private/index.js
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
/**
@module @ember-data/serializer
*/

export { default as EmbeddedRecordsMixin } from './embedded-records-mixin';
export { modelHasAttributeOrRelationshipNamedType } from './utils';
4 changes: 4 additions & 0 deletions packages/serializer/addon/-private/utils.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { get } from '@ember/object';

/**
@module @ember-data/serializer
*/

/*
Check if the passed model has a `type` attribute or a relationship named `type`.
Expand Down
4 changes: 4 additions & 0 deletions packages/serializer/addon/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
/**
@module @ember-data/serializer
*/

export { default } from './serializer';
2 changes: 1 addition & 1 deletion packages/serializer/addon/json-api.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
@module ember-data
@module @ember-data/serializer
*/

import { typeOf, isNone } from '@ember/utils';
Expand Down
4 changes: 4 additions & 0 deletions packages/serializer/addon/json.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ import { modelHasAttributeOrRelationshipNamedType } from './-private';
import { normalizeModelName } from '@ember-data/store';
import { coerceId } from '@ember-data/store/-private';

/**
@module @ember-data/serializer
*/

const emberAssign = assign || merge;

/**
Expand Down
2 changes: 1 addition & 1 deletion packages/serializer/addon/rest.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
@module ember-data
@module @ember-data/serializer
*/

import { typeOf, isNone } from '@ember/utils';
Expand Down
3 changes: 1 addition & 2 deletions packages/serializer/addon/serializer.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
@module ember-data
@module @ember-data/serializer
*/

import EmberObject from '@ember/object';
Expand All @@ -20,7 +20,6 @@ import EmberObject from '@ember/object';
[DS.JSONSerializer](DS.JSONSerializer), the included JSON serializer.
@class Serializer
@namespace DS
@extends EmberObject
*/

Expand Down
4 changes: 4 additions & 0 deletions packages/serializer/addon/transform.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
@module @ember-data/serializer
*/

// TODO: @heroiceric
// These individual transforms shouldn't be exported
export { default as BooleanTransform } from './transforms/boolean';
Expand Down
4 changes: 4 additions & 0 deletions packages/serializer/addon/transforms/boolean.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import { isNone } from '@ember/utils';
import Transform from './transform';

/**
@module @ember-data/serializer
*/

/**
The `BooleanTransform` class is used to serialize and deserialize
boolean attributes on Ember Data record objects. This transform is
Expand Down
4 changes: 4 additions & 0 deletions packages/serializer/addon/transforms/date.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import Transform from './transform';

/**
@module @ember-data/serializer
*/

/**
The `DateTransform` class is used to serialize and deserialize
date attributes on Ember Data record objects. This transform is used
Expand Down
4 changes: 4 additions & 0 deletions packages/serializer/addon/transforms/number.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import Transform from './transform';

/**
@module @ember-data/serializer
*/

function isNumber(value) {
return value === value && value !== Infinity && value !== -Infinity;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/serializer/addon/transforms/string.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import { isNone as none } from '@ember/utils';
import Transform from './transform';

/**
@module @ember-data/serializer
*/

/**
The `StringTransform` class is used to serialize and deserialize
string attributes on Ember Data record objects. This transform is
Expand Down
5 changes: 4 additions & 1 deletion packages/serializer/addon/transforms/transform.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import EmberObject from '@ember/object';

/**
@module @ember-data/serializer
*/

/**
The `Transform` class is used to serialize and deserialize model
attributes when they are saved or loaded from an
Expand Down Expand Up @@ -69,7 +73,6 @@ import EmberObject from '@ember/object';
```
@class Transform
@namespace DS
*/
export default EmberObject.extend({
/**
Expand Down
4 changes: 4 additions & 0 deletions packages/store/addon/-private/identifiers/cache.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ import isStableIdentifier from './is-stable-identifier';
import isNonEmptyString from '../utils/is-non-empty-string';
import Store from '../system/store';

/**
@module @ember-data/store
*/

interface KeyOptions {
lid: IdentifierMap;
id: IdentifierMap;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { StableRecordIdentifier, IS_IDENTIFIER } from '../ts-interfaces/identifier';

/**
@module @ember-data/store
*/

export default function isStableIdentifier(identifier: any): identifier is StableRecordIdentifier {
return identifier[IS_IDENTIFIER] === true;
}
4 changes: 4 additions & 0 deletions packages/store/addon/-private/identifiers/utils/uuid-v4.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
@module @ember-data/store
*/

// support IE11
declare global {
interface Window {
Expand Down
4 changes: 4 additions & 0 deletions packages/store/addon/-private/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
@module @ember-data/store
*/

// // public
export { default as Model } from './system/model/model';
export { default as Errors } from './system/model/errors';
Expand Down
Loading

0 comments on commit 63e13ba

Please sign in to comment.