Package org.plumelib.javadoclookup

Class CreateJavadocIndex

java.lang.Object

org.plumelib.javadoclookup.CreateJavadocIndex

public final class CreateJavadocIndex
extends Object

CreateJavadocIndex reads API documentation files (typically index-all.html files) and outputs an index that Emacs can use for looking up Java documentation.

With no arguments, it reads file ~/.javadoc-index-files, which should contain a list of API documentation files, one per line. Blank lines are permitted in the file, as are comment lines that start with "#".

For example, run it like this:

 java -cp .../javadoc-lookup/build/libs/javadoc-lookup-all.jar \
   org.plumelib.javadoclookup.CreateJavadocIndex > ~/.javadoc-index.el
 

Method Summary

Modifier and Type	Method	Description
static void	main(String[] args)	Scan the specified file(s) for an API documentation index and print the corresponding entries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

main

public static void main(String[] args)
                 throws IOException

Scan the specified file(s) for an API documentation index and print the corresponding entries.

Parameters:

args - command-line arguments: index-all.html files

Throws:

IOException - if there is a problem reading a file