spark-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Burak Yavuz <brk...@gmail.com>
Subject Re: Helpful IntelliJ shortcuts for working with Javadoc / Scaladoc
Date Wed, 08 Jul 2015 23:29:23 GMT
This is awesome Josh! Very helpful. Thanks for sharing!

Burak

On Wed, Jul 8, 2015 at 3:57 PM, Josh Rosen <joshrosen@databricks.com> wrote:

> 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
>
>
>
>

Mime
View raw message