Making nice function docs appear on ctrl+q

When I hover over a function and do ctrl+q the phpdocs for that function will be displayed in a popup dialog.

Only the formatting isn't very nice.  all the text that might be separated by linebreaks for readablity in the phpdocs above the function is stripped of linebreaks and run together.

Is there a nice way of adding more readablilty to my docs, so that the docs can be refrenced while writing code?

example, this:
* jrCore_router_shutdown_function()
* Run when the process exits to allow event listeners
* to do any cleanup that may be needed.  Also kicks off
* the daily maintenance cycle.

becomes this:
jrCore_router_shutdown_function() Run when the process exits to allow event listeners to do any cleanup that may be needed.  Also kicks off the daily maintenance cycle.

anyway to keep it how it was or put additional info into another section of the popup?

1 comment
Comment actions Permalink

Hi michael,

There is no option to display such text as is (i.e. treat your new line as new line in documentation popup).

Your only choice here is to use HTML to denote end of line (e.g. <br /> ... or you can use paragraph <p> to explicitly state that it is separate thing (in terms of formatting)).

0

Please sign in to leave a comment.