javadoc2ceylondoc

This tool converts javadoc-style comments into ceylondoc-style comments. Example:

Input:

/**
 * The best program ever
 *
 * well, if you’re a fan of programs that are too lazy for even a proper hello world, that is.
 */
shared void run() {
    print("hi");
}

Output:

"The best program ever
 
 well, if you’re a fan of programs that are too lazy for even a proper hello world, that is."
shared void run() {
    print("hi");
}

Processed elements

• @author → by
• @throws → throws
• @see → see
• {@link} → [[]]
• {@code} → ``
• HTML:
  • <b>: bold
  • <i>: italics
  • <tt>: monospaced
  • <p>: Markdown paragraphs

Usage

ceylon run herd.javadoc2ceylondoc inputFileName outputFileName

If inputFileName and/or outputFileName are missing, /dev/stdin and /dev/stdout are used instead, but special files aren’t (yet) supported by the Ceylon SDK (see ceylon/ceylon-sdk#121), so at the moment you can’t pipe code into javadoc2ceylondoc.

TODO

• @param → parameter doc