common document

[kermit10000000]

common document to track current project tree and current functionality

[JaroslawWiosna]

@kermit10000000 let's consider doxygen comments, like

/**
 * @brief Some description
 *
 * @param [in] std::size_t abc
 * @param [in] double xyz
 *
 * @todo TODO some todo
 * @return Returns something...
 */

...before each declaration of function

[kermit10000000]

The idea looks fine to me. It will make small parts more clear. Although, I think we also need something to see the big picture as a whole as well.

[JaroslawWiosna]

@kermit10000000 looks like we could use doxygraph Since we have already agreed than doxygen comments is necessary, I think this 'doxygraph' thing may by worth trying...

[kermit10000000]

Since we already agreeded for this solution i would like to ask you for updating some files in a free time in doxygen comments as I did. In case of big pictures since we have also agreeded that doxygen will work here too,I have a proposal. My proposition is creating class for handling doxygen linux commands and calling this object methods in main to achieve new doxygen file with every run and keep the created file updated in repo. For the first part i ask for your replay and in terms of the second part i seek some discussion soon.

[JaroslawWiosna]

OK, I am preparing some comments, like in b0f361d

[kermit10000000]

Update about big picture proposition. I have found some commands for running doxygen: http://www.tutorialspoint.com/unix_commands/doxygen.htm . Now i am looking for some specific commands for doxygraph

[JaroslawWiosna]

With 8d68daa I have prepared initial doxygen. City.hpp is not included in documentation, unfortunately... But I will work on it. Please refer to README. I included mini-tutorial about doxygen.

---

EDIT: ...and about the big picture. I think we should discuss it in person.

[kermit10000000]

big picture solved by @JaroslawWiosna with doxygen documents and graphs(effect for example can be seen in README.md )