Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Should we describe modules and namespaces in JSDoc? #334

Closed
maxbarnas opened this issue Sep 23, 2016 · 1 comment
Closed

Should we describe modules and namespaces in JSDoc? #334

maxbarnas opened this issue Sep 23, 2016 · 1 comment
Labels
resolution:duplicate This issue is a duplicate of another issue and was merged into it. status:discussion

Comments

@maxbarnas
Copy link
Contributor

maxbarnas commented Sep 23, 2016 •
edited
Loading

While working on https://github.com/ckeditor/ckeditor5-engine/issues/610 I tried to describe modules and namespaces (in corresponding *.jsdoc file). I noticed lack of any output after generating documentation.

This might be of course my lack of knowledge about JSDoc, but the question that came to me is - does separate description of module at the top of module's source file and description of namespace in *.jsdoc file really needed?
@maxbarnas maxbarnas added this to the iteration 3 milestone Sep 23, 2016
@maxbarnas maxbarnas mentioned this issue Sep 23, 2016
Merged
@maxbarnas maxbarnas changed the title Should we describe modules in JSDoc? Should we describe modules and namespaces in JSDoc? Sep 23, 2016
@Reinmar
Copy link
Member

Reinmar commented Sep 26, 2016

After we switch to @modules this won't be an issue, because it will be natural to document every one of them.

See #328.

@Reinmar Reinmar closed this as completed Sep 26, 2016
@Reinmar Reinmar removed this from the iteration 3 milestone Sep 26, 2016
@Reinmar Reinmar added the resolution:duplicate This issue is a duplicate of another issue and was merged into it. label Sep 26, 2016
mlewand added a commit that referenced this issue May 1, 2020
@mlewand
Merge pull request #334 from ckeditor/i/6526
0af7997 
Feature: Provided support for plural forms internalization. Part of #6526.

MINOR BREAKING CHANGE: The `translate` function from the `translation-service` was marked as protected. See #334.
MINOR BREAKING CHANGE: The format of translations added to the editor has been changed. If you use `window.CKEDITOR_TRANSLATIONS` please see #334.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
resolution:duplicate This issue is a duplicate of another issue and was merged into it. status:discussion
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Reinmar @maxbarnas