title: What is the correct way put multiple lines in a param tag for a Javadoc?
body: <p>I can't find any information on whether or not it is ok to have multiple lines of info in a javadoc param. I'm making a chess engine and I want to be able to parse a string to generate a board. Is it ok to do it as I've done below?</p>
  
  <pre><code>/**
   * Creates a board based on a string.
   * @param boardString The string to be parsed. Must be of the format:
   *      "8x8\n" +
   *      "br,bn,bb,bq,bk,bb,bn,br\n" +
   *      "bp,bp,bp,bp,bp,bp,bp,bp\n" +
   *      "  ,  ,  ,  ,  ,  ,  ,  \n" +
   *      "  ,  ,  ,  ,  ,  ,  ,  \n" +
   *      "  ,  ,  ,  ,  ,  ,  ,  \n" +
   *      "  ,  ,  ,  ,  ,  ,  ,  \n" +
   *      "wp,wp,wp,wp,wp,wp,wp,wp\n" +
   *      "wr,wn,wb,wq,wk,wb,wn,wr"
   */
  </code></pre>
  
  <p>Edit: This has been marked as a duplicate. The reason I believe it is not a duplicate is because the other question is simply about creating a multiline javadoc comment, while this one is about having multiple lines as part of the param argument.</p>