Wikia

Vim Tips Wiki

Changes: Vim Doclet

Edit

Back to page

(Insert subpage argument (where new tip discussed))
(Change <tt> to <code>, perhaps also minor tweak.)
 
Line 3: Line 3:
 
|previous=1532
 
|previous=1532
 
|next=1534
 
|next=1534
|created=November 27, 2007
+
|created=2007
 
|complexity=intermediate
 
|complexity=intermediate
 
|author=[[Davetron5000|David Copeland]]
 
|author=[[Davetron5000|David Copeland]]
Line 11: Line 11:
 
|category2=
 
|category2=
 
}}
 
}}
By running a doclet on the JDK source code, you can put the resulting Vim help files in your help path and read Javadoc from directly within Vim. <tt>:help String</tt> and <tt>:help java.util.List</tt> bring up the javadoc for those files, within Vim. Everything's hyperlinked and the entire javadoc is present.
+
By running a doclet on the JDK source code, you can put the resulting Vim help files in your help path and read Javadoc from directly within Vim. <code>:help String</code> and <code>:help java.util.List</code> bring up the javadoc for those files, within Vim. Everything's hyperlinked and the entire javadoc is present.
   
If you set <tt>keywordprg</tt> to blank, you can do a <tt>K</tt> on any Java keyword and bring up the javadoc quickly. This has really cut down on the amount of time I spend outside Vim while coding.
+
If you set <code>keywordprg</code> to blank, you can do a <code>K</code> on any Java keyword and bring up the javadoc quickly. This has really cut down on the amount of time I spend outside Vim while coding.
   
Go to [http://vimdoclet.sourceforge.net vimdoclet.sourceforge.net] to download the doclet and see what the output looks like. There is a sample download of javadoc for <tt>java.lang</tt> and <tt>java.util</tt> if you'd like to try it out before running the doclet.
+
Go to [http://vimdoclet.sourceforge.net vimdoclet.sourceforge.net] to download the doclet and see what the output looks like. There is a sample download of javadoc for <code>java.lang</code> and <code>java.util</code> if you'd like to try it out before running the doclet.
   
 
<gallery>
 
<gallery>

Latest revision as of 06:30, July 13, 2012

Tip 1533 Printable Monobook Previous Next

created 2007 · complexity intermediate · author David Copeland · version 7.0


By running a doclet on the JDK source code, you can put the resulting Vim help files in your help path and read Javadoc from directly within Vim. :help String and :help java.util.List bring up the javadoc for those files, within Vim. Everything's hyperlinked and the entire javadoc is present.

If you set keywordprg to blank, you can do a K on any Java keyword and bring up the javadoc quickly. This has really cut down on the amount of time I spend outside Vim while coding.

Go to vimdoclet.sourceforge.net to download the doclet and see what the output looks like. There is a sample download of javadoc for java.lang and java.util if you'd like to try it out before running the doclet.

CommentsEdit

Around Wikia's network

Random Wiki