Restyle Comments

[a-teammate]

This Issue is related to #87 and https://github.com/inexor-game/code/wiki/Documentation

Some parts which are already documented probably needs some style fixes.

( See wiki page )

[bobbybrot]

Hi all, this issue caught my eye and I was hoping to provide some assistance. As a side note, I am new to GitHub and have not been involved in an Open Source Project before, I hope that you guys can help me out and guide me to where and how I should begin.

Many thanks.

[Fohlen]

Hello @bobbybrot and welcome to Inexor! 🙌 Probably the best way is to

• compile Inexor (if you need assistance with this, join us on Riot
• study the source code in the inexor-folder
• create a new branch via your git client (we recommend a graphical client, such as SmarGit or SourceTree)
• commit and push your restyled changes
• create a pull request
• we will guide you through the process of creating, updating and making your PR ready

[a-teammate]

Hey there @bobbybrot! :)

On which platform are you?

Notes: There is currently a PR pending which moves a lot of code around: #455. In order to simplify merging the changes you do, maybe it's best to start from that branch (remove_standalone2) and not from the master branch. (join in riot if you do not know how)

Additional/or in lieu of what Fohlen said you could start with generating the documentation and fixing the warnings which appear doing that.

To do that run doxygen inside the inexor-core folder (doxygen doxygen.conf is probably the command for that).

Sidenote: That command will generate the documentation in the folder doc/. You could open doc/index.html afterwards to see the generated docs.

[bobbybrot]

Hey @a-teammate & @Fohlen thanks for getting back to me. I am currently using Windows as my platform. I plan to use Visual Studio 2013 professional to do tasks that require looking into code.

[bobbybrot]

Hi all, as an update I have finalized making the necessary changes to the commenting styles and warnings that were present when using doxygen, I shall be submitting a commit shortly. Unfortunately, there are a few warnings which needs the attention of someone who is more familiar with the code to be corrected. I have made a custom text file which contains all the final warnings that needed further looking into. In the meantime, I hope the commit changes are acceptable.

[bobbybrot]

Documentation leftover.txt

[Fohlen]

Nice work!! Thanks for your contribution :+1:

[bobbybrot]

@Fohlen I want to confirm with you if you have received my commit changes. I am being told by github the following

[bobbybrot]

When clicking the 'Push origin' button on the very top

[Fohlen]

@bobbybrot you must fork and make a pull request (probably the last link is easier).

[bobbybrot]

https://github.com/inexorgame/inexor-core/pull/466

There we go, thanks for the help. I'll be keeping my eye out on my pull request to see if there is anything else that needs doing.

While that is underway, is there anything else that needs to be done to close this issue while the pull request is under way?

Many thanks.

B.Singh

[bobbybrot]

@Fohlen

[bobbybrot]

Even though more fixes have been made based on feedback and is now awaiting further review, there are still some functions that are not documented which will cause doxygen (the program used to create the documentation for us) to produce warning messages when run. I have attached a document to this comment which shows the remaining functions that need documenting (or commenting) by someone who is familiar with the code base.

[bobbybrot]

Documentation.leftover.txt