javadoc-template-sample.md

Javadoc comments

class header

/**
* Describe the class here.
*
* {@link some.other.class.Documentation} for linking to other docs or symbols
* {@link some.other.class.Documentation 
* {@code code goes here} for formatting as code
* {@literal <>[]()foo} for interpreting literal text without converting to HTML markup
* or other tags.
* 
* @author surname
* @version 1.0
* @since 15/04/2021
* @see some.other.class.Documentation
* @deprecated This class has been replaced by some.other.package.BetterFileReader
**/
public class GameEngine{
  
  private 3DModel world;
}

function header

/**
* @param stream Describe this parameter. Include as much detail as is appropriate
*
* Parameter docs are commonly aligned as here, but this is optional.
*
* @return Describe the return values. Include as much detail as is appropriate
*
* @throws Exception Describe when and why this exception can be thrown.
*
* @since 1.0.0
* @see some.other.class.Documentation
* @deprecated Describe why this method is outdated. A replacement can also be specified.
*/
private boolean isServerActive(Url serverUrl){
  return httpBuilder.get(serverUrl);
}

codeblock in javadoc

/**
* The Class RenderUtils.
* <p>
* This is an {@code inline("code example")}.
* <p>
* You should wrap it in pre tags when writing multiline code.
* <pre>{@code
* renderUtils = new RenderUtils();
* renderUtils.cleanScreen();
* renderUtils.setLib(Bulkan.class);
* renderUtils.setHDR(Raytracing);
* }</pre>
* <p>
* be carefull with the optimization and cuda cores nvidia.
*/
class RenderUtils {
}