Hi there,
I’m quite new to the coding side of plex/xbmc and have some problems finding into the code. One of the biggest issue is that there doesn’t seem to be any kind of documentation for the code. In the xbmc wiki I found that one should document his code in a way that doxygen is able to generate an api-doc out of it.
Fun part is: I tried to generate a doc with oxygen from the current plex repository (tag v0.8.1) and have received a completely empty doc which is consistent with my observations that there is rarely anything commented in the whole code.
Am I missing something here? Is there some kind of documentation that covers the overall project structure and how things like skin-interpretation and so on are done? I really can’t believe one is supposed to read all of the code to be able to work in this project.
greetings gsnerf
also there is not a single comment in the media server plugin framework code either. it makes the code really difficult to read if you’re not the one that wrote it and it makes figuring out what an object does and how nearly impossible. i don’t know if this is a purposeful oversight to confuse people or just a really bad habit of developers who save time at the expanse of an obfuscated codebase that is impossible to work with. proper and complete code commenting and documentation is absolutely essential in an open source project, because the source is not really open if no one can tell what the hell it does.
Yea well, I found this thread in the xbmc forums where one of the devs basically admits that there is no useful documentation:
http://xbmc.org/forum/showthread.php?t=536…e+documentation
Scary development tactics, if I would develop like that at work I’d instantly be thrown out…
Well I started reading through the code and comment anything I understand, lets see where this ends 
greetings
This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.
