{"id":18,"date":"2020-09-27T07:27:54","date_gmt":"2020-09-27T05:27:54","guid":{"rendered":"https:\/\/blogs.scummvm.org\/b-gent\/?p=18"},"modified":"2022-04-15T08:54:55","modified_gmt":"2022-04-15T06:54:55","slug":"gsod-week-2","status":"publish","type":"post","link":"https:\/\/blogs.scummvm.org\/b-gent\/2020\/09\/27\/gsod-week-2\/","title":{"rendered":"GSoD week 2"},"content":{"rendered":"<p>Hi!<\/p>\n<p>Looking at the timeline of my GSoD proect, this week was supposed to be about refreshing the doxygen skin. I worked a bit with the doxygen CSS to make the doc output more coherent with the currect ScummVM website, for example using similar colors. This didn&#8217;t turn out to be a great idea and decreased the overall readability of documentation, so in the end, this change has been reverted. As agreed through a Discord poll, we are going back to a vanilla doxygen skin for now.<\/p>\n<p>At the same time, I am still working on header files from the common folder. Let me explain what I mean when say I&#8217;m &#8216;working&#8217; on them:<\/p>\n<p><!--more--><\/p>\n<ul>\n<li>\u00a0Make sure each header has a @defgroup element with (at least) a decent group decription.<\/li>\n<li>\u00a0Make sure the language is grammatically correct and coherent. I will write a blog post with a summary of the styleguide that I&#8217;m using. It&#8217;s really just in my head right now and should ideally end up as part of this documentation in the future.<\/li>\n<li>\u00a0Correct doxygen errors, for example:\n<ul>\n<li>Typos in doxygen commands.<\/li>\n<li>Discrepancies when describing parameters in functions (different parameter name in the doxygen block vs what is in the code).<\/li>\n<li>Fixing broken references.<\/li>\n<li>Escaping characters that create problems. For example, doxygen will try to interpret anything within sharp brackets &#8216;&lt;&gt;&#8217; as an HTML\/XML element.<\/li>\n<li>Add @name commands to group some related structures.<\/li>\n<\/ul>\n<\/li>\n<li>What I should be doing more &#8211; trying to figure out and add descriptions for some functions or missing parameters. This is the hardest part for a non-developer who isn&#8217;t very familiar with the project yet.<\/li>\n<\/ul>\n<div>Another PR with some more reviewed header files is <a href=\"https:\/\/github.com\/scummvm\/scummvm\/pull\/2488\" target=\"_blank\" rel=\"noopener\">open now<\/a>.<\/div>\n<div><\/div>\n<p>Week 3 and 4 are officially focused on documenting the common code. I got myself a bit of a headstart but this is a massive chunk of work so keep your fingers crossed for me!<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Hi! Looking at the timeline of my GSoD proect, this week was supposed to be about refreshing the doxygen skin. I worked a bit with the doxygen CSS to make the doc output more coherent with the currect ScummVM website, for example using similar colors. This didn&#8217;t turn out to be a great idea and [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2],"tags":[],"class_list":["post-18","post","type-post","status-publish","format-standard","hentry","category-google-season-of-docs"],"_links":{"self":[{"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/posts\/18","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/comments?post=18"}],"version-history":[{"count":2,"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/posts\/18\/revisions"}],"predecessor-version":[{"id":22,"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/posts\/18\/revisions\/22"}],"wp:attachment":[{"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/media?parent=18"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/categories?post=18"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/tags?post=18"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}