adobe / brackets

An open source code editor for the web, written in JavaScript, HTML and CSS.
http://brackets.io
MIT License
33.25k stars 7.63k forks source link

Code Hinting documentation issue: JavaScript-Code-Hints “Advanced Hinting” section #10814

Open danyocom opened 9 years ago

danyocom commented 9 years ago

Hi, The doc located here https://github.com/adobe/brackets/wiki/JavaScript-Code-Hints mentions the ability for a code hint to have a pop out containing more complete documentation (parameters, description, return type).

"Documentation on a function or variable will pop out to the side of the main hint window when a hint is highlighted. A small delay between highlighting a hint and displaying the documentation will prevent flash in the case where the user is quickly moving through the hints. The documentation for functions will contain the function signature, origin, description, parameters, and return type. The documentation window for variables and properties will show the type, origin, and description. The figure below shows a documentation hint for a highlighted function."

Question: Is there a documented API (or suggested method) for doing this?

I want to achieve something similar to the image below (image take from brackets 2012 design draft: http://blog.brackets.io/2012/07/13/design_draft_code_hinting/ )

Thanks, Dan

nethip commented 9 years ago

@danyocom I will check back on this and get back to you.

nethip commented 9 years ago

@RaymondLim I looked at the code to check if we have something like what @danyocom was asking for, but could not find any. Can you tell us if this feature went into any of the sprints?

RaymondLim commented 9 years ago

Sorry @nethip Documentation hint is not implemented yet. You can remove (or comment on) the changes made in https://github.com/adobe/brackets/wiki/JavaScript-Code-Hints/_compare/3c5dac39e04761b226b7083f5de6456043fe83a2...71b6bff3ca2d019e60f6b6a9c770c83500ec36c3.

nethip commented 9 years ago

@RaymondLim Thanks for clarifying! I will update the documentation with this.