memberof does not cascade down to class members

[webOS101]

With the following code:

/** @module module */

/**
 * @class Clazz
 * @memberof module
 */
class Clazz {
	/** Whatever */
	member = 7
}

The member member gets documented as a root-level item with "memberof": "Clazz",. It really should be a memberof module.Clazz. Adding an explicit memberof does allow it to generate the correct docs. This is possibly related to #417 but seems to be more an extension of the same problem. (I already think there's an open issue that @module should already imply that Clazz is a memberof module. If not, I'll be happy to create one)

[tmcw]

Looks like this equivalent to a simpler case, like

/** a */
var a = {
  /** b */
  b: {
    /** c */
    c: {}
  }
};

Which produces

• a
  • b
• c

Which is obviously, embarrassingly wrong. The tree-construction step in hierarchy.js needs a serious rethink.

[bpatram]

@tmcw Do you know when/if you'll be able to get to this issue? It's blocking some efforts on my end when documenting a few libraries!

[tmcw]

Hi @bpatram - I'm taking some time off from daily work on this project in order to see if any other contributors spring up. While I really enjoy working on this project, working on it solo is not sustainable for me. Which means - I'd happily review a PR and help out if you want to try and help! The linked source and the nesting refactor #732 would serve as an example for how this code needs to be improved.

Otherwise, I can't really offer any guess or estimate of when I would get to this issue, since I have many priorities, open source and otherwise. If this is very important to you, please consider contributing - this project will only succeed if the community helps.

[maciej-ka]

I started debugging src/infer/membership.js to find a reason for this problem.

[maciej-ka]

Seems that comment /** c */ doesn't fit to any of conditions in this inferMembership block, while comment /** b */ is handled by this case

I have two ideas for the solution, should send MR soon.

Plan A: add some recursion when checking conditions in inferMembership block

Plan B: inferMembership will probably assign something to comment as a result (perhaps comment["memberof]") and maybe it's possible to use that value assigned to comment /** b */ when processing comment /** c */ (however this would assume that comments are in some parent-child relation before calculating memberof, which I guess is not true).

Few maybes because I'm quite new to the project, but this shouldn't be hard to solve.