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.

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

Procedure description attribute #54

Closed
retailcoder opened this issue Nov 19, 2014 · 4 comments
Closed

Procedure description attribute #54

retailcoder opened this issue Nov 19, 2014 · 4 comments
Assignees
Labels
enhancement Feature requests, or enhancements to existing features. Ideas. Anything within the project's scope. module-and-procedure-attributes
Milestone

Comments

@retailcoder
Copy link
Member

This feature allows the user to enter a short description for a module member, to appear in the object browser when it is selected.

related: #48 & #49 (same prerequesites, although like #52 it can work off temporary files)

@retailcoder retailcoder added this to the Module & Procedure Attributes milestone Nov 19, 2014
@rubberduck203 rubberduck203 modified the milestone: Module & Procedure Attributes Feb 10, 2015
@retailcoder retailcoder added this to the Future Versions milestone Feb 10, 2015
@retailcoder
Copy link
Member Author

Again (sorry for all the notifications!), @ckuhn203 is the SCI code responsible for exporting/importing modules decoupled enough to be reused for this?

@rubberduck203
Copy link
Member

Yes. Absolutely. It's implemented through VBE extensions. IIRC it's even located in the VBE project.

@retailcoder retailcoder modified the milestones: Version 2.0, Future Versions Sep 22, 2015
@retailcoder retailcoder added the up-for-grabs Use this label in conjunction with a difficulty level label, e.g. difficulty-02-ducky label Sep 22, 2015
@retailcoder
Copy link
Member Author

As of yesterday, we're reading these attributes into Declaration objects. I feel like delaying writing to 2.x, there's really quite a bit of work left to do with the other core things.

@retailcoder retailcoder modified the milestones: v2.1, Version 2.0 Mar 18, 2016
@retailcoder retailcoder added the difficulty-03-duck Involves more challenging problems and/or developing within and revising the internals API label Feb 16, 2017
@retailcoder retailcoder removed difficulty-03-duck Involves more challenging problems and/or developing within and revising the internals API up-for-grabs Use this label in conjunction with a difficulty level label, e.g. difficulty-02-ducky labels Mar 13, 2017
@retailcoder
Copy link
Member Author

Per linked issue, this will be implemented as annotations:

'@ModuleAttribute.VB_Description("This module is responsible for XYZ")
'@MemberAttribute.VB_Description("This procedure is responsible for XYZ")

Or:

'@Description("This module is responsible for XYZ")

The @Description annotation would be context-sensitive and become a module attribute when found in the declarations section, or a member attribute when found in a procedure.

This annotation will require an inspection to ensure only one attribute is created per scope.

@Vogel612 Vogel612 added the enhancement Feature requests, or enhancements to existing features. Ideas. Anything within the project's scope. label Dec 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Feature requests, or enhancements to existing features. Ideas. Anything within the project's scope. module-and-procedure-attributes
Projects
None yet
Development

No branches or pull requests

4 participants