Are you going to provide a chart/squema where we can see the class structure? #21
Replies: 3 comments
-
I agree that adding doc comments to the top of files and functions would improve the experience for all of us who are new to the codebase. I've taken the liberty of opening a pull request that adds a basic Doxygen configuration that can be used to publish class diagrams. As comments are added to the codebase, this documentation can be automatically updated, providing additional context. |
Beta Was this translation helpful? Give feedback.
-
Also @jamiefaye mentioned an open source app called Sourcetrail that shows class hierarchy diagrams. It runs on Windows, macOS and linux. It might help. https://github.com/CoatiSoftware/Sourcetrail |
Beta Was this translation helpful? Give feedback.
-
apart from visualisers of structures/classes aka Doxygen and co, it makes also sense to declare where such have to be written and in what exact format. As seen all just an example ///Myclass to handle all xyz
class Myclass : InheritedClass {
///doStuff does stuff ...
///@param size Size of something
///@param length length of something
doStuff(uint32 size, uint16 length);
} Why the example? Because |
Beta Was this translation helpful? Give feedback.
-
Right now looking at the code feels really chaotic and it is like trying to decipher a hieroglyph. It would be really cool if we could have a diagram that for example says (graphically) the Song class contains n Clip instances, with explanations of what each class represents and which is its function. After a look at the code, the initial comment of each file is the typical license agreement text, but I miss some big comment that explains what that class does or represents in the whole application.
Beta Was this translation helpful? Give feedback.
All reactions