Fix: broken output in Documentation Code Snippets

AdarshRawat1 commented 2 months ago

Recent Update to PR

I'm pushing a temporary fix for the code output renders. I'll be reaching out to the Doxygen team about the issue, and hopefully, it will be resolved in the next release. The issue arises when we include one README file within another; in this case, the code blocks are not processed correctly.

What was done

I made a copy of broken code snippets

The original copy is kept to correctly render code in GitHub Markdown preview. ( This is hidden from doxygen using \internal command. )
The copy snippet is enclosed in \code{.c} & \endcode commands of Doxygen. Because these commands are capable of rendering the snippets correctly even when included from external Markdown.

Changes

Minor fixes in documentation output.

Screenshots of Changes

- Current - https://p4lang.github.io/p4c/intermediate_representation_ir.html#visitors-and-transforms ![image](https://github.com/user-attachments/assets/cb0b6197-8468-4f87-bdd0-0fdfdd0a21a9) - Updated ![image](https://github.com/user-attachments/assets/a1a30c97-3cae-49c1-8809-34636cc3e961)

Screenshots of Broken codes for multiple Markdowns

- Broken Code snippets for merged Markdown files ![image](https://github.com/user-attachments/assets/c52fe71d-7102-4f1b-b0be-b79395c0dedd) - Fixed ![image](https://github.com/user-attachments/assets/941ea7ba-a5bf-402b-ae6e-5394292a98c7)