docs: Add API documentation for prettyDisplay methods

[mitsuki31]

Overview

This pull request introduces comprehensive Javadoc documentation for the prettyDisplay methods, enhancing the clarity and usability of the API. The changes include detailed descriptions, parameter explanations, example outputs, and API notes for the prettyDisplay overloads.

Changes Made

API Documentation for prettyDisplay

• Added detailed Javadoc comments for the following methods:
  • prettyDisplay()
  • prettyDisplay(boolean showIndices)
  • prettyDisplay(int index)
  • prettyDisplay(int index, boolean showIndices)
  • {static} prettyDisplay(double[][] arr)
  • {static} prettyDisplay(double[][] arr, boolean showIndices)
  • {static} prettyDisplay(double[][] arr, int index)
  • {static} prettyDisplay(double[][] arr, int index, boolean showIndices)
• Descriptions include:
  • Explanation of method functionality.
  • Parameter definitions.
  • Example output formatting for both matrix display and index visibility.
  • Clarification on edge case handling, such as null or empty matrices and arrays.
• Added an API note for the alias methods to ensure consistency.

Benefits

• Improves the readability and usability of the prettyDisplay methods.
• Helps developers understand the usage and output formatting options.
• Ensures a consistent documentation style across the codebase.
• The changes also include updates to suppress warnings during compiling sources and generating Javadocs, ensuring a cleaner build process with linter support.