mslehre / MAS

Maximum Acyclic Subgraph (MAS) - Multiple Sequence Alignment (MSA) Game
1 stars 0 forks source link

Fix documentation #24

Open felbecker opened 5 years ago

felbecker commented 5 years ago

The documentation (https://mslehre.github.io/MAS/) still needs some work here and there. I will assign you to this issue, if your code is related.

felbecker commented 5 years ago

@Luc4sQ , your documentation here https://mslehre.github.io/MAS/classcolorlist.html looks confusingly e.g. in the method void colorlist::updateList. Edit: It seems like some doxygen comments in your .cc files are messing it up. You don't need to describe local variables with ///< in your source code. I think you can fix the documentation by replacing ///< with // in your .cc files.

felbecker commented 5 years ago

@sebastianbierb , can you add doxygen comments to the graph class in your next pull request please? This has high priority as the graph class is frequently used by others. Please make sure your public methods are well described and it is clear what to used them for and how.