Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
[Doxygen] Include github markdown file for code guidelines #15756
Includes the markdown file we have on github also on doxygen.
Motivation and Context
Right now we have two files in different formats for the same content. Code guidelines were updated recently on github but not on doxygen. There are some issues with the solution:
Maybe something may be worked in the future to solve the issues in doxygen. For now, better than having incorrect duplicated content.
How Has This Been Tested?
compile docs and see. Check codedocs
Screenshots (if appropriate):
You can see the end result here: https://codedocs.xyz/enen92/xbmc/md_docs__c_o_d_e__g_u_i_d_e_l_i_n_e_s.html
Types of change
That's very good for me to have only one place, and if the Markdown support in doxygen is now better +1 :-). With the same things in different places brings otherwise always deviations.
I hope with the links becomes fixed soon by doxygen (otherwise we become issue's :-D )