I cannot find any information on whether it is good to have several lines of information in the javadoc parameter. I am making a chess engine, and I want to be able to parse a line to create a board. Can this be done as I did below?
/**
* 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"
*/
Edit: this has been marked as duplicate. The reason I think this is not a duplicate is that another question is to simply create a multi-line javadoc comment, while this is due to having multiple lines as part of the param argument.