dojo / core

:rocket: Dojo 2 - language helpers and utilities.
http://dojo.io
Other
213 stars 58 forks source link

Add api data and update README for doc viewer #389

Closed jason0x43 closed 6 years ago

jason0x43 commented 6 years ago

references dojo/dojo.io#418

Type: feature

Adds API doc data and updates README for the dojo.io doc viewer.

jason0x43 commented 6 years ago

Note that the PatchRecord type in src/compare.ts had to be modified to get typedoc to process the project:

PatchRecord =
    // | {
    //      /**
    //       * The name of the property on the Object
    //       */
    //      name: string;

    //      /**
    //       * The type of the patch
    //       */
    //      type: 'delete';
    //  }
    {
            /**
             * A property descriptor that describes the property in `name`
             */
            descriptor: PropertyDescriptor;

            /**
             * The name of the property on the Object
             */
            name: string;

            /**
             * The type of the patch
             */
            type: 'add' | 'update' | 'delete';

            /**
             * Additional patch records which describe the value of the property
             */
            valueRecords?: (ConstructRecord | PatchRecord | SpliceRecord)[];
        };