<meta http-equiv="content-type" content="text/html; charset=utf-8"><span class="Apple-style-span" style="border-collapse: collapse; font-family: arial, sans-serif; font-size: 13px; ">> Hey there,<br>><br>> First, thanks for the effort of discussing documentation related issues (there<br>
> are quite some) in Amarok, but...<br>><br>> I'm *all* for doing this the other way around:<br>> Better put the class/architectural documentation into the source code as far<br>> as possible. Qt does that very heavily and succeeds in providing an<br>
> comprehensive and up-to-date source code documentation as developers are still<br>> paying attention to it. I'm not really convinced that stuff like that should<br>> go to a Wiki anyway.<br>> (You could still link from the Wiki to our apidocs, though).<br>
><br>> Reasoning is obvious:<br>> * Wiki-Documentation quickly gets out of date / out of sync with source code.<br>> * Long-time involved developers (as me) don't look at / adjust it at all.<br>> ?(I'm pretty sure I'm not the only one here, heh)<br>
><br>> Doing inline documentation will also have the positive side-effect that our<br>> API-docs may get polished sooner or later.<br>><br>> Thoughts?<br><br></span><div><span class="Apple-style-span" style="border-collapse: collapse; font-family: arial, sans-serif; font-size: 13px; ">>What Kevin said.<br>
>Typing // or /** and then some stuff is way quicker and easier than<br>>editing some wiki page. The time that would be wasted on wiki markup<br>>is better spent coding and documenting inline. There's of course no<br>
>problem in generating apidocs from there or even copying it to a wiki,<br>>but documentation in the code should come first.<br>>Cheers,<br>>--<br>>Teo</span></div><div><span class="Apple-style-span" style="border-collapse: collapse; font-family: arial, sans-serif; font-size: 13px; "><br>
</span></div><div><font class="Apple-style-span" face="arial, sans-serif"><span class="Apple-style-span" style="border-collapse: collapse;">What you said does make sense. If the documentation in the code is finished faster, it would benefit people who look at the code.</span></font></div>
<div><font class="Apple-style-span" face="arial, sans-serif"><span class="Apple-style-span" style="border-collapse: collapse;"><br></span></font></div><div><font class="Apple-style-span" face="arial, sans-serif"><span class="Apple-style-span" style="border-collapse: collapse;">Thanks,</span></font></div>
<div><font class="Apple-style-span" face="arial, sans-serif"><span class="Apple-style-span" style="border-collapse: collapse;">Sandeep</span></font></div>