Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doxygen] Include github markdown file for code guidelines #15756

Merged
merged 1 commit into from Mar 16, 2019

Conversation

enen92
Copy link
Member

@enen92 enen92 commented Mar 16, 2019

Description

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:

  • Links in the table of contents do not work
  • Some strange characters at the beginning of the page (already fixed in the current doxygen version)

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

  • Bug fix (non-breaking change which fixes an issue)
  • Clean up (non-breaking change which removes non-working, unmaintained functionality)
  • Improvement (non-breaking change which improves existing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that will cause existing functionality to change)
  • Cosmetic change (non-breaking change that doesn't touch code)
  • None of the above (please explain below)

@enen92 enen92 added Type: Cleanup non-breaking change which removes non-working or unmaintained functionality Type: Improvement non-breaking change which improves existing functionality Documentation v18 Leia labels Mar 16, 2019
@enen92 enen92 added this to the Leia 18.2-rc1 milestone Mar 16, 2019
@enen92 enen92 requested a review from yol March 16, 2019 01:16
@AlwinEsch
Copy link
Member

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 )

Copy link
Member

@yol yol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a bunch! 👍

@enen92 enen92 merged commit 59cbeb7 into xbmc:master Mar 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Type: Cleanup non-breaking change which removes non-working or unmaintained functionality Type: Improvement non-breaking change which improves existing functionality v18 Leia
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants