| 1 | /**
|
| 2 | * @license
|
| 3 | * Copyright (c) 2015 The Polymer Project Authors. All rights reserved.
|
| 4 | * This code may only be used under the BSD style license found at
|
| 5 | * http://polymer.github.io/LICENSE.txt
|
| 6 | * The complete set of authors may be found at
|
| 7 | * http://polymer.github.io/AUTHORS.txt
|
| 8 | * The complete set of contributors may be found at
|
| 9 | * http://polymer.github.io/CONTRIBUTORS.txt
|
| 10 | * Code distributed by Google as part of the polymer project is also
|
| 11 | * subject to an additional IP rights grant found at
|
| 12 | * http://polymer.github.io/PATENTS.txt
|
| 13 | */
|
| 14 | import * as jsdoc from '../javascript/jsdoc';
|
| 15 | import { ScannedEvent } from '../model/model';
|
| 16 | import { ScannedPolymerElement } from './polymer-element';
|
| 17 | /**
|
| 18 | * Annotates Hydrolysis scanned features, processing any descriptions as
|
| 19 | * JSDoc.
|
| 20 | *
|
| 21 | * You probably want to use a more specialized version of this, such as
|
| 22 | * `annotateElement`.
|
| 23 | *
|
| 24 | * Processed JSDoc values will be made available via the `jsdoc` property on a
|
| 25 | * scanned feature.
|
| 26 | */
|
| 27 | export declare function annotate(feature: {
|
| 28 | jsdoc?: jsdoc.Annotation;
|
| 29 | description?: string;
|
| 30 | }): void;
|
| 31 | /**
|
| 32 | * Annotates @event, @hero, & @demo tags
|
| 33 | */
|
| 34 | export declare function annotateElementHeader(scannedElement: ScannedPolymerElement): void;
|
| 35 | /**
|
| 36 | * Annotates event documentation
|
| 37 | */
|
| 38 | export declare function annotateEvent(annotation: jsdoc.Annotation): ScannedEvent;
|