Please use the Apache issue tracking system for new NetBeans issues (https://issues.apache.org/jira/projects/NETBEANS0/issues) !!

Bug 217324

Summary: Code Documentation Popup
Product: editor Reporter: mtrivino_111
Component: CSL (API & infrastructure)Assignee: Milutin Kristofic <mkristofic>
Status: REOPENED --- QA Contact: issues <issues.netbeans.org>
Priority: P3 CC: msk
Version: 7.2   
Target Milestone: 7.3   
Hardware: PC   
OS: Windows 7 x64   
Whiteboard:
Issue Type: DEFECT Exception Report:
Attachments: Documentation Popup cuts off content

Description mtrivino_111 2012-08-23 18:30:34 UTC
Created attachment 123480 [details]
Documentation Popup cuts off content

The Code Documentation Popup cuts off the content.

We have been using Netbeans 7.2 for PHP for 2 months now.  I started using the APIGen, your preferred code documentation generator, last week.  I added my documentation code with the following format:

/**
 * Description here...
 * 
 * @param ...
 *
 * @param ...
 * 
 * etc..
 *
 * @return ...
 */
public function Send(array $pFrom, array $pTo, $pSubject, $pMsg) {

}


Press and hold the Ctrl-key and hover over the 'Send' function name.
You would then see a documentation popup for it.  It is important to know where the 'Send' function is located in your screen.  If the 'Send' function is scrolled  in the middle of the screen, the popup is cut-off (please see attached image).  If the 'Send' function is at the top or the bottom of the screen, it looks fine.  Of course, this issue would also depend on the amount of content you have with your documentation.

I suggest using a vertical scrollbar when content exceeds the size of the popup.
Thank you very much!
Comment 1 Tomas Mysik 2012-08-24 08:51:59 UTC
Editor area, reassigning.
Comment 2 Ondrej Brejla 2012-08-24 09:17:36 UTC
It's not handled by PHP. We just return a string which represents a tooltip content. Displaying is handled by upper infrastructure (GsfHyperlinkProvider and then NbToolTip?). Reassigning for evaluation. Thanks.
Comment 3 Milutin Kristofic 2012-09-13 13:54:57 UTC
In java, ctrl on object shows just function or class signature, ctrl+shift+space shows javadoc. In Php, you show same phpdoc in both actions. I would not show phpdoc in ctrl + action. Ctrl+shift+space is more appropriate documentpopup with scrolling and html browsing.
Comment 4 Ondrej Brejla 2012-09-17 08:33:20 UTC
But we can't recognize if the request was send by Ctrl+MouseOver or Ctrl+Shift+Space. Both cases are handled by CodeCompletionHandler.document() method. Once called from GoToCupport and once from GsfCompletionDoc. So probably new API should be introduced in CSL API to distinguish these two different cases.
Comment 5 Milutin Kristofic 2012-09-18 16:16:59 UTC
Ok, I will add this to csl api.
Comment 6 Milutin Kristofic 2012-11-28 10:44:40 UTC
*** Bug 222829 has been marked as a duplicate of this bug. ***
Comment 7 Martin Balin 2015-09-17 10:59:25 UTC
Report from old NetBeans version. Due to code changes since it was reported likely to not happen. Feel free to reopen if happens in 8.0.2 or 8.1.
By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2014, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo