Skip to content

add support for @package access #962

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
Closed
myphysicslab opened this issue Mar 19, 2015 · 3 comments
Closed

add support for @package access #962

myphysicslab opened this issue Mar 19, 2015 · 3 comments
Labels
feature
Milestone
3.5.0

Comments

@myphysicslab
Copy link

In addition to the @Private and @Protected tags, closure compiler also supports @Package, which corresponds to the notion from Java of "package private":
https://developers.google.com/closure/compiler/docs/js-for-compiler

Marks a member or property as package private. Only code in the same directory can access names marked @Package. In particular, code in parent and child directories cannot access names marked @Package.

It would be great for JSDoc to add this if not too difficult. I see @Package listed in issue #605, but no separate issue for it. For me, just being able to exclude items marked @Package from the JSDoc output would be useful.
@hegemonic hegemonic mentioned this issue Mar 20, 2015
Closed
45 tasks
@hegemonic hegemonic added this to the 3.4.0 milestone Mar 20, 2015
@hegemonic
Copy link
Contributor

Yep, this one is on the list of tags to implement. I'll try to prioritize this one.

@smeijer smeijer mentioned this issue Apr 4, 2015
Closed
@vickychijwani
Copy link

This would be great to have. My use-case is the same as @myphysicslab's.

@hegemonic hegemonic mentioned this issue Aug 13, 2015
Closed
@hegemonic hegemonic modified the milestones: 3.5.0, 3.4.0 Oct 21, 2015
hegemonic added a commit that referenced this issue Jul 7, 2017
@hegemonic
add package tag (#962)
ca1c4f2
@hegemonic
Copy link
Contributor

Fixed on master. The @package tag will be supported in JSDoc 3.5.0.

@hegemonic hegemonic mentioned this issue Jul 7, 2017
Closed
lheberlie added a commit to bsvensson/jsdoc that referenced this issue Aug 15, 2017
@lheberlie
Merge tag '3.5.0' into esrijs-sdk-3.5.4
c33c1b2 
3.5.0

* tag '3.5.0': (97 commits)
  3.5.0
  bump revision; start 3.6.0-dev
  update 3.5.0 changelog
  3.5.0 changelog
  reformat changelog
  add yields tag (jsdoc#1388)
  resolve the path to the JS config file before requiring it (jsdoc#1386)
  support namespaces that are also functions (jsdoc#955)
  add hideconstructor tag (jsdoc#952)
  add package tag (jsdoc#962)
  autodetect default and repeatable parameters when a function is assigned to a variable (jsdoc#1054)
  correctly document constructors and instance properties of ES2015 classes (jsdoc#1182)
  add sourceType config option
  fix crash when the author tag is empty (jsdoc#1289)
  add recurseDepth config option (jsdoc#1340)
  support bigint
  support import.meta
  support optional chaining
  support numeric separators
  support dynamic import
  ...

# Conflicts:
#	.eslintrc
#	README.md
#	lib/jsdoc/fs.js
#	lib/jsdoc/opts/args.js
#	lib/jsdoc/src/astbuilder.js
#	lib/jsdoc/src/astnode.js
#	lib/jsdoc/src/handlers.js
#	lib/jsdoc/src/parser.js
#	lib/jsdoc/src/visitor.js
#	lib/jsdoc/src/walker.js
#	lib/jsdoc/tag/dictionary/definitions.js
#	lib/jsdoc/tag/validator.js
#	lib/jsdoc/util/markdown.js
#	lib/jsdoc/util/templateHelper.js
#	package.json
#	templates/default/static/styles/jsdoc-default.css
#	templates/haruki/publish.js
#	test/spec-collection.js
#	test/specs/documentation/defaultparams.js
#	test/specs/documentation/restparams.js
#	test/specs/jsdoc/src/astnode.js
#	test/specs/jsdoc/util/templateHelper.js
@aweebit aweebit mentioned this issue Aug 7, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature
Projects
None yet
Milestone
3.5.0
Development

No branches or pull requests
3 participants
@vickychijwani @hegemonic @myphysicslab