Add example usage (markdown?) to JavaDocs

Question

Say I have this:

Is there a way to add markdown or html to each method, with an example of how to use the method? I am thinking an expanding panel - button says view example and it opens a panel.

I tried adding this to the inline docs:

 /**
   * <pre>
   * <code>new BeanTranslator.Builder()
   *   .translate(
   *     new{@code Translator<String, Integer>}(String.class, Integer.class){
   *      {@literal @}Override
   *       public Integer translate(String instance) {
   *         return Integer.valueOf(instance);
   *       }})
   *   .build();
   * </code>
   * </pre>
   */
  @SuppressWarnings("Duplicates")
  public static <I, T, V, E> void Reduce(I initialVal, List<T> tasks, Asyncc.Reducer<V, E> m, Asyncc.IAsyncCallback<V, E> f) {
    NeoReduce.Reduce(initialVal, tasks, m, f);
  }

but I only see this on the right side:

Elater

Answer 1

There is a library that allows to use Markdown and even PlantUML in Javadocs like this:

/**
* Java Example:
*
* ```java
* @Override
* public void myMethod() {
* }
* ```
*/

Depot

thanks i tried installing using maven and got an error, filed a ticket with them, i got it working with html instead of markdown, but would be cool to get markdown working too thanks – Elater

The folllowing guide does an overview about how to use this librar, however, it doesn't seem like it is an standard so I would be wary about using it. mscharhag.com/java/using-markdown-syntax-in-javadoc – Cloakroom