akveo/doc-prsr

Simple parser to normalize typdoc and doc.js output

doc-prsr's Issues

Mark @private methods and properties and `private=true`

Currently, methods and properties marked with @private tag are not ignored and included into the final output. We need a way to control these methods/properties on the client side so that we can remove them or mark as private. So I propose to add a property private which will be resulted in true when @private tag exists on an element.
Code

Result

Bug: the following peace of code breaks the parser

  protected validateToken(module: string) {
    return map((res) => {
      const token = this.getConfigValue('token.getter')(module, res);
      if (!token) {
        const key = this.getConfigValue('token.key');
        console.warn(`NbEmailPassAuthProvider:
                          Token is not provided under '${key}' key
                          with getter '${this.getConfigValue('token.getter')}', check your auth configuration.`);

        throw new Error('Could not extract token from the response.');
      }
      return res;
    });
  }

Sometimes complex return or property types aren't parsed or parsed inrorectly

1 Menu Component, property type

/**
   * List of menu items.
   * @type List<NbMenuItem> | List<any> | any
   */
  @Input() items: NbMenuItem[];

2 User Component, property type

  /**
   * List of menu items for a user context menu (shown when clicked)
   * @type NbUserMenuItem[]
   */
  @Input() menu: NbUserMenuItem[] = [];

3 MediaBreakpoint service, return parameter

  /**
   * Returns a map of configured breakpoints for the theme
   * @returns {[p: string]: number}
   */
  getBreakpointsMap(): { [breakpoint: string]: number } {
    return this.breakpointsMap;
  }

Inherited from property add tests

Bug: the following code breaks the prsr

https://github.com/tibing/nebular/tree/feature/popover

More Documentation

This project looks interesting, but could you expand the README to better explain what it does and how to use it?

React Native: Method parser crashes

Method parser crashes if method documentation contains no arguments

Example

 * @method {() => void} focus - Requests focus for the given input or view. The exact behavior triggered
 * will depend on the platform and type of view.

Quick fix

To get rid of this I've simply modified methods.parser.js :)

function getParamType(param) {
  const splitElement = param.split(':')[1];
  var crudeParam = splitElement && splitElement.trim();
  return crudeParam && crudeParam.split(' ')[0].trim();
}

As you can see, I simply do nothing if split function returns undefined
But it also results in incorrect output

DeprecationWarning: Calling an asynchronous function without callback is deprecated.

NODE v7.2.1