Fix Docs for Modules and Refactor @publicModule tag to @exportedAs

[petebacondarwin]

@naomiblack and @mhevery

• this PR fixes the module documentation issue. Now you can provide a jsdoc style comment block at the top of the module definition file that must include the @module tag to indicate that it documents the module rather than code components exported from the module. Also you now specify that a module is or public consumption by applying the @public tag on the module itself. For example:

/**
 * @module
 * @public
 * @description
 * This block contains markdown that describe this module.
 */

The other major change in this PR is that the @publicModule tag has been replaced with the @exportedAs tag, which can be applied multiple times to a single code component. What this implies is that the associated code component has also been exported on other modules.

Closes #1258

[mhevery]

Why the rename? I think publicModule is a better name. Can you share your thoughts?

[mhevery]

I think it should be exportedAs

[mhevery]

Rename exportedFrom to exportedAs

[petebacondarwin]

The reason for the rename is that it no longer puts the onus on the exported component to tell that the module is public. This is also considerably more flexible as it allows modules that only contain direct exports and not reexports to be public. Also it allows items to be decl

[petebacondarwin]

Phone finger slippage...

Also it allows components to be reexported internally too for the private docs

[petebacondarwin]

Regarding the naming...

The tag is attached to a component that is an export on a private module. The tag declares that this component is also exported from another module. Exported as implies that a module is being aliased, which is not accurate.

But if you are sure you want it that way then I can change it.

[mhevery]

I think exportedAs is still right. As it is being aliased.
It will be available from two places, it is just that we will not publish the original place.

[petebacondarwin]

@mhevery - updated with @exportedAs. Feel free to get someone to merge once the rename PR has gone in.

[angular-automatic-lock-bot]

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}