A small Ceylon tool to convert javadoc to ceylondoc.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ceylon
.settings
source/herd/javadoc2ceylondoc
test-samples
test/test/herd/javadoc2ceylondoc
.classpath
.gitignore
.project
LICENSE
README.md

README.md

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

  • @authorby
  • @throwsthrows
  • @seesee
  • {@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