yadop/built/lib/processor.d.ts

Yet another Doc Parser

import Configuration from './configuration';
import * as doctrine from 'doctrine';
/** Docs processor. */
declare class Processor {
    private configuration;
    private DEFAULT_CWD;
    private DEFAULT_PATTERN;
    private DEFAULT_IGNORE;
    private ESPREE_PARSE_OPTIONS;
    private pattern;
    private options;
    /**
     * Constructor.
     * @param configuration The configuraton object.
     */
    constructor(configuration: Configuration);
    /**
     * Process all matching files and return the comments.s
     * @return {[Comment,Comment,Comment,Comment,Comment]}
     */
    process(): doctrine.Annotation[];
    /**
     * Reads and parses the provided file using espree.
     * @param file The file
     * @return {Comment[]} comments The comments from the provided file.
     * @private
     */
    private _toEspreeComments;
    /**
     * Merge the comments.
     * @param previousComments The list of previous comments.
     * @param currentComments The list of current comments.
     */
    private _concatComments;
    /**
     * Converts the espree comments to doctrine.Annotations.
     * @param comment The comment.
     * @private
     */
    private _toDoctrineComments;
}
export default Processor;