colorsystem: doxygen comments adjusted

mslehre / MAS

Maximum Acyclic Subgraph (MAS) - Multiple Sequence Alignment (MSA) Game

1 stars 0 forks source link

colorsystem: doxygen comments adjusted #27

Closed Luc4sQ closed 5 years ago

Luc4sQ commented 5 years ago

Notes:

I've adjusted the doxygen comments so, that they are all in the header file and removed all from my test program. (I've made many doxygen comments to standard c++ comments)
I've adjusted the iterator of all for loops, where the comparison variable was an unsigned integer, to prevent warnings

felbecker commented 5 years ago

Thanks. Can you add a "\brief" in front of the descriptions of the public member methods in your header files so that they occur in the documentation? I will merge when this is done.

@sebastianbierb Just seen when compiling this. The graph class produces the same compilation warnings that Lukas had. You compare signed to unsigned integers. Can you plese fix this in the next pull request of yours?

Luc4sQ commented 5 years ago

Wie meinst du das? Meine Public Member methods haben doch alle eine doxygen beschreibung.

Luc4sQ commented 5 years ago

Also, ist \brief nicht nur für Kurzbeschreibungen da? /** Ist doch der Indikator für ein Doxygen comment. (Soweit ich das verstanden habe)

felbecker commented 5 years ago

Du scheinst recht zu haben, es müsste auch so gehen. Ich weiß aber nicht, ob das Format bei Doxygen schöner aussieht, wenn man \brief benutzt. Ich merge mal und schaue, wie es dann aussieht und ob es einen Unterschied macht.