Issue #14759: Enhanced cmdline options documentation by tabular format

[MANISH-K-07]

Aims to close #14759

WIP ....

[MANISH-K-07]

Github, generate website

[github-actions[bot]]

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/0dd175c_2024115629/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/0dd175c_2024115629/cmdline.html#CLI_Options

[MANISH-K-07]

Github, generate website

[github-actions[bot]]

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/9796faf_2024130406/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/9796faf_2024130406/cmdline.html#CLI_Options

[MANISH-K-07]

Github, generate website

[github-actions[bot]]

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/be937af_2024143303/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/be937af_2024143303/cmdline.html#CLI_Options

[MANISH-K-07]

The anchors are working just as suggested at https://github.com/checkstyle/checkstyle/issues/14759#issuecomment-2038627651

Not yet sure why the test is unable to read option -c description from doc. (failure) Looking into it....

[MANISH-K-07]

@romani , @rnveach , @nrmancuso , any thoughts on this ?

[nrmancuso]

@romani , @rnveach , @nrmancuso , any thoughts on this ?

The table looks great, let's make CI happy

[MANISH-K-07]

let's make CI happy

Still trying to debug why the -c option node is not being read despite the fact that it is available in the table :(

[MANISH-K-07]

@romani , @nrmancuso , I am having a bit of trouble debugging the test file. Could you please help me with why the firstChild is not being mapped?

[romani]

@MANISH-K-07 , please help to finish this PR

[MANISH-K-07]

@MANISH-K-07 , please help to finish this PR

https://github.com/checkstyle/checkstyle/pull/14799#discussion_r1571624993 still no thought on this..

[romani]

[ERROR] CliOptionsXdocsSyncTest.validateCliDocSections:75 CLI Option: -c present in Main.java but not documented in cmdline.xml.vm expected not to be: null

[romani]

GitHub, generate website

[github-actions[bot]]

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/6b63421_2024160342/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/6b63421_2024160342/cmdline.html#CLI_Options

[romani]

It would be awesome to put anchor to each line as we did at this table https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/6b63421_2024160342/google_style.html#a1

It would help a lot to reference exact parameter for users when they have a question

[rnveach]

Option column is the anchor in this iteration. There is no image, it is just a clickable link.

[romani]

Ok, this works, we just need to fix test to pass.