docs: Add the API docs for prettyDisplay methods

This API documentation addition includes detailed description and parameters, example usages along with the expected output, and an API note for alias methods.

This change also suppress warnings during compiling sources or generating Javadoc with linter enabled.