You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by Đạt Cao Mạnh <ca...@gmail.com> on 2015/07/09 02:54:37 UTC
Fwd: Helpful IntelliJ shortcuts for working with Javadoc / Scaladoc
Found this helpful tip in spark-dev
---------- Forwarded message ----------
From: "Josh Rosen" <jo...@databricks.com>
Date: 9 Jul 2015 05:57
Subject: Helpful IntelliJ shortcuts for working with Javadoc / Scaladoc
To: <sp...@apache.org>
Cc:
Here's a helpful IntelliJ feature for writing and browsing Scala/Javadoc:
You can press Ctrl-j (or View menu -> Quick Documentation) to bring up a
popup which displays the Scaladoc / Javadoc for the currently-selected
symbol:
[image: Inline image 2]
This window has a few neat features to make documentation writing easier.
If you press the pin button in the upper right-hand corner, the popup
window will be replaced by a window which stays on screen as you navigate
around the code:
[image: Inline image 3]
There are options to anchor this as a floating window or to pin it into the
side context bar:
[image: Inline image 4]
In this persistent window, there is one useful option to make documentation
easier to work with. The "Auto Update from Source" option causes the
documentation to automatically refresh when you select a different symbol
or when you edit the documentation itself. This allows you to have a live
preview when writing documentation.
[image: Inline image 6]
This feature has some limitations (namely, line breaks and lists in
Scaladoc aren't rendered the same way that they would be in the displayed
Scaladoc on the website), but most Scaladoc features work (including the
{{{ syntax for code examples) and it works perfectly for Javadoc.
Anyhow, just wanted to share this feature because it's a big productivity
improver when writing docs.
- Josh
Re: Helpful IntelliJ shortcuts for working with Javadoc / Scaladoc
Posted by Erick Erickson <er...@gmail.com>.
Sweet! FWIW, it's f1 on OS X
On Tue, Jul 14, 2015 at 8:57 AM, Alessandro Benedetti <
benedetti.alex85@gmail.com> wrote:
> Good to know !
> Thanks !
>
> Cheers
>
> 2015-07-09 1:54 GMT+01:00 Đạt Cao Mạnh <ca...@gmail.com>:
>
>> Found this helpful tip in spark-dev
>> ---------- Forwarded message ----------
>> From: "Josh Rosen" <jo...@databricks.com>
>> Date: 9 Jul 2015 05:57
>> Subject: Helpful IntelliJ shortcuts for working with Javadoc / Scaladoc
>> To: <sp...@apache.org>
>> Cc:
>>
>> Here's a helpful IntelliJ feature for writing and browsing Scala/Javadoc:
>>
>> You can press Ctrl-j (or View menu -> Quick Documentation) to bring up a
>> popup which displays the Scaladoc / Javadoc for the currently-selected
>> symbol:
>>
>> [image: Inline image 2]
>>
>> This window has a few neat features to make documentation writing
>> easier. If you press the pin button in the upper right-hand corner, the
>> popup window will be replaced by a window which stays on screen as you
>> navigate around the code:
>>
>> [image: Inline image 3]
>>
>> There are options to anchor this as a floating window or to pin it into
>> the side context bar:
>>
>> [image: Inline image 4]
>>
>> In this persistent window, there is one useful option to make
>> documentation easier to work with. The "Auto Update from Source" option
>> causes the documentation to automatically refresh when you select a
>> different symbol or when you edit the documentation itself. This allows
>> you to have a live preview when writing documentation.
>> [image: Inline image 6]
>>
>> This feature has some limitations (namely, line breaks and lists in
>> Scaladoc aren't rendered the same way that they would be in the displayed
>> Scaladoc on the website), but most Scaladoc features work (including the
>> {{{ syntax for code examples) and it works perfectly for Javadoc.
>>
>> Anyhow, just wanted to share this feature because it's a big productivity
>> improver when writing docs.
>>
>> - Josh
>>
>>
>>
>>
>
>
> --
> --------------------------
>
> Benedetti Alessandro
> Visiting card - http://about.me/alessandro_benedetti
> Blog - http://alexbenedetti.blogspot.co.uk
>
> "Tyger, tyger burning bright
> In the forests of the night,
> What immortal hand or eye
> Could frame thy fearful symmetry?"
>
> William Blake - Songs of Experience -1794 England
>
Re: Helpful IntelliJ shortcuts for working with Javadoc / Scaladoc
Posted by Alessandro Benedetti <be...@gmail.com>.
Good to know !
Thanks !
Cheers
2015-07-09 1:54 GMT+01:00 Đạt Cao Mạnh <ca...@gmail.com>:
> Found this helpful tip in spark-dev
> ---------- Forwarded message ----------
> From: "Josh Rosen" <jo...@databricks.com>
> Date: 9 Jul 2015 05:57
> Subject: Helpful IntelliJ shortcuts for working with Javadoc / Scaladoc
> To: <sp...@apache.org>
> Cc:
>
> Here's a helpful IntelliJ feature for writing and browsing Scala/Javadoc:
>
> You can press Ctrl-j (or View menu -> Quick Documentation) to bring up a
> popup which displays the Scaladoc / Javadoc for the currently-selected
> symbol:
>
> [image: Inline image 2]
>
> This window has a few neat features to make documentation writing easier.
> If you press the pin button in the upper right-hand corner, the popup
> window will be replaced by a window which stays on screen as you navigate
> around the code:
>
> [image: Inline image 3]
>
> There are options to anchor this as a floating window or to pin it into
> the side context bar:
>
> [image: Inline image 4]
>
> In this persistent window, there is one useful option to make
> documentation easier to work with. The "Auto Update from Source" option
> causes the documentation to automatically refresh when you select a
> different symbol or when you edit the documentation itself. This allows
> you to have a live preview when writing documentation.
> [image: Inline image 6]
>
> This feature has some limitations (namely, line breaks and lists in
> Scaladoc aren't rendered the same way that they would be in the displayed
> Scaladoc on the website), but most Scaladoc features work (including the
> {{{ syntax for code examples) and it works perfectly for Javadoc.
>
> Anyhow, just wanted to share this feature because it's a big productivity
> improver when writing docs.
>
> - Josh
>
>
>
>
--
--------------------------
Benedetti Alessandro
Visiting card - http://about.me/alessandro_benedetti
Blog - http://alexbenedetti.blogspot.co.uk
"Tyger, tyger burning bright
In the forests of the night,
What immortal hand or eye
Could frame thy fearful symmetry?"
William Blake - Songs of Experience -1794 England