Categories
Google Season of Docs

GSoD week 6

Hi!

Just a quick update this week.

I’m still waiting for someone to have a look at PRs #2535 and #2499. Hopefully they can get it soon.

I have quite a bit of work done locally but I’m not in a hurry to open another PR. My plan is to open a PR around the weekend with 10 more high-priority files with added/edited doxygen comments. The files in question will be the ones from stream.h up to metaengine.h from this list.

I am still investing a significant chunk of my time into developing the knowledge of aspects of C++ used in ScummVM headers. Figuring out how streams work was the latest challenge 🙂

Categories
Google Season of Docs

GSoD week 5

Hi!

The last week has been very busy and I’ve spent a lot of time working on finalizing PRs #2535 and #2499. The diff is quite massive so good luck to the reviewers 🙂

I am slowly crawling through the high-priority header files, as defined in the spreadsheet. Some of them can be really time-consuming, I think I spent over two days on str.h. A huge chunk of this time is spent on reading, googling, and expanding my knowledge of C++: how to understand operator functions, how iterators work, streams, arrays, lists, strings…I’m surely learning a lot but it annoys that it takes so much time that is then not really reflected in the work I’m submitting.

Categories
Google Season of Docs

GSoD week 4

Hi!

I’m doing this blog post a bit late when week 5 has already started. I’ve had some busy, tough days recently due to sick family (autumn and kids generally don’t go well together) and couldn’t devote as much time as I would like for my GSoD project. I’m a bit behind on the timeline right now but not really worried as I’m sure I can catch up with everything.

Right now PR#2499 is open with some more reviewed header files from the common folder. This is something I would probably like to get merged as soon as possible.

Categories
Google Season of Docs

GSoD week 3

Hi!

Work is ongoing and I am still mostly focusing on reviewing doxygen blocks in the header files of the ‘common’ folder.

In the meantime, some things have been merged:

  • PR#2361 – documentation generated from the ‘common’ folder is now nicely structured and divided into groups. Grouping will ultimately be applied to all header files in the project.
  • PR#2457 – 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)
  • PR#2467 – doc edits in header files
  • PR#2488 – doc edits in header files