Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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

About

A small Ceylon tool to convert javadoc to ceylondoc.

Resources

License

Packages

No packages published

Languages