| Summary: | Code Browser fails to display documentation for Qt functions | ||
|---|---|---|---|
| Product: | [Applications] kdevelop | Reporter: | Martin Fuhrer <mfuhrer> |
| Component: | Documentation viewer | Assignee: | kdevelop-bugs-null |
| Status: | REPORTED --- | ||
| Severity: | normal | CC: | gael.lebaccon, master.haber |
| Priority: | NOR | ||
| Version: | 5.3.0 | ||
| Target Milestone: | --- | ||
| Platform: | Appimage | ||
| OS: | Linux | ||
| Latest Commit: | Version Fixed In: | ||
| Sentry Crash Report: | |||
i've seen something similar but different on my version. I get all my qt documentation, but they are shifted by one element (it shows me the documentation for the next item on the list instead) Ian, yes, I've encountered the one-element shift as well. So to summarize, I encounter one of three scenarios: * the inline documentation displays fine. * the inline documentation doesn't display (only the "Show documentation for Class::function" link is available). * the inline documentation displays but is for the next item. Also, in my description summary, I meant to write "The Code Browser in KDevelop..." I confirm, at least, the first two scenarios on branch master. |
SUMMARY The Code Browser in Qt fails to display inline documentation for many Qt functions. By the same token, when the Code Browser is not displayed, the pop up box that appears when hovering the cursor over a function call in the text editor also fails to display inline documentation for the same Qt functions. I did not encounter these issues in KDevelop 4.x. STEPS TO REPRODUCE 1. Place the following code into a document and open with KDevelop: #include <QString> void foo() { QString str; str.append( "more " ); str.replace( "mo", "ca" ); str.trimmed(); } 2. Open the Code Browser (or observe the pop up box). 3. Hover the cursor over append. Documentation displays as expected. 4. Hover the cursor over replace. Documentation does not display as expected. 5. Hover the cursor over trimmed. Documentation does not display as expected. OBSERVED RESULT For (5), the Code Browser (or pop up box) displays: QString trimmed() Container: QString Access: public Kind: Function constant Decl.: qstring.h :405 Show uses Show documentation for QString::trimmed EXPECTED RESULT For (5), the code browser in KDevelop 4 displays full inline documentation: QString trimmed() Container: QString Access: public Kind: Function constant Decl.: qstring.h :420 Show uses Returns a string that has whitespace removed from the start and the end. Whitespace means any character for which QChar::isSpace() returns true. This includes the ASCII characters '\t', '\n', '\v', '\f', '\r', and ' '. Example: QString str = " lots\t of\nwhitespace\r\n "; str = str.trimmed(); // str == "lots\t of\nwhitespace" Unlike simplified(), trimmed() leaves internal whitespace alone. See also simplified(). Show documentation for QString::trimmed ADDITIONAL INFORMATION Though clicking the "Show documentation for QString::trimmed" link allows the documentation to be displayed in the Documentation viewer, this is much less convenient than immediately seeing the inline documentation when hovering the cursor over a function. It worked consistently in KDevelop 4.x, but frequently fails to work in KDevelop 5.x. Perhaps a parsing issue?