Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Stackoverflow markup for javadoc

Tags:

After a while, I'm back writing JavaDoc. At the same time I grew fond of SO's markup, which is way more readable in plaintext than HTML. (Even the back tick which I never used before, ever).

/**  * I'm talking about things like <code>ClassName</code> here.  * <p>  * And of course the well-known <code>&lt;p&gt;</code>.<br>  * Should I go on?  */ 

Has anyone written some filter thingy which translates SO markup to HTML in the JavaDoc tool chain?

Alternatively as comments any pointers would be welcome how to write extensions to JavaDoc with such functionality (I'm mainly interested in the interface if there is any available).

like image 699
vbence Avatar asked May 23 '11 08:05

vbence


1 Answers

There appears to be a Markdown Doclet for Javadoc, which should do what you want.

It's made by StackOverflow-user Richard Nichols. He has written a blog post on it, which includes a screenshot, of some example input/output.

like image 92
Sebastian Paaske Tørholm Avatar answered Oct 07 '22 01:10

Sebastian Paaske Tørholm