Showing posts with label Javadoc. Show all posts
Showing posts with label Javadoc. Show all posts

Friday, 25 November 2011

Javadoc: link to method in same file


/**
 *... {@link #foo(String)} ...
 */
private void documentedMethod() { ... }

private void foo(String param) { ... }

Monday, 14 November 2011

How to include XML source code in Javadoc

/**
  * <pre>
  * {@code
  * 
  * //XML code
  * <strong>Foo</strong>
  *
  * }
  * </pre>
  */
  • {@code ... } escapes XML tags
  • pre preserve white spaces and line breaks

How to include Java source code in Javadoc

/**
  * 
  * {@code
  * 
  * //Java code
  * System.out.println("foo");
  *
  * 
*/
  • {@code ... } escapes XML tags
  • pre preserve white spaces and line breaks