{"id":20,"date":"2020-10-05T07:28:53","date_gmt":"2020-10-05T05:28:53","guid":{"rendered":"https:\/\/blogs.scummvm.org\/b-gent\/?p=20"},"modified":"2022-04-15T08:54:49","modified_gmt":"2022-04-15T06:54:49","slug":"gsod-week-3","status":"publish","type":"post","link":"https:\/\/blogs.scummvm.org\/b-gent\/2020\/10\/05\/gsod-week-3\/","title":{"rendered":"GSoD week 3"},"content":{"rendered":"<p>Hi!<\/p>\n<p>Work is ongoing and I am still mostly focusing on reviewing doxygen blocks in the header files of the &#8216;common&#8217; folder.<\/p>\n<p>In the meantime, some things have been merged:<\/p>\n<ul>\n<li><a href=\"https:\/\/github.com\/scummvm\/scummvm\/pull\/2361\" target=\"_blank\" rel=\"noopener\">PR#2361<\/a>\u00a0&#8211; documentation generated from the &#8216;common&#8217; folder is now nicely structured and divided into groups. Grouping will ultimately be applied to all header files in the project.<\/li>\n<li><a href=\"https:\/\/github.com\/scummvm\/scummvm\/pull\/2457\">PR#2457<\/a>\u00a0&#8211; everyone can now easily build the doxygen documentation using a make command or the provided .sh script (big thanks to Thierry for his help with the scripts)<\/li>\n<li><a href=\"https:\/\/github.com\/scummvm\/scummvm\/pull\/2467\" target=\"_blank\" rel=\"noopener\">PR#2467<\/a>\u00a0&#8211; doc edits in header files<\/li>\n<li><a href=\"https:\/\/github.com\/scummvm\/scummvm\/pull\/2488\" target=\"_blank\" rel=\"noopener\">PR#2488<\/a>\u00a0&#8211; doc edits in header files<\/li>\n<\/ul>\n<p><!--more--><\/p>\n<p>The last two PRs are merged but if you look into them, you&#8217;ll be able to find my summary of the missing documentation which we haven&#8217;t yet worked on. There is a lot to add and I can&#8217;t do it on my own so any kind of help from the development team will be greatly appreciated. Creating developer documentation is always a cooperation between an SME and a tech writer so without you guys my powers are limited \ud83d\ude42<\/p>\n<p>During this week I also had a very interesting checkpoint call with my mentor Eugene where we clarified certain aspects of my GSoD project. I won&#8217;t bore you with details but the scope and priority of tasks is now much better defined and I&#8217;m sure it&#8217;s going to positively affect my progress.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Hi! Work is ongoing and I am still mostly focusing on reviewing doxygen blocks in the header files of the &#8216;common&#8217; folder. In the meantime, some things have been merged: PR#2361\u00a0&#8211; documentation generated from the &#8216;common&#8217; folder is now nicely structured and divided into groups. Grouping will ultimately be applied to all header files in [&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-20","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\/20","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=20"}],"version-history":[{"count":1,"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/posts\/20\/revisions"}],"predecessor-version":[{"id":21,"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/posts\/20\/revisions\/21"}],"wp:attachment":[{"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/media?parent=20"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/categories?post=20"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.scummvm.org\/b-gent\/wp-json\/wp\/v2\/tags?post=20"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}