[Maria-developers] No Doxygen?
I was kind of surprised to not find anything in MariaDB's build system for using Doxygen to create HTML docs. Have people decided this isn't a worthwhile thing to do? Or has just no one gotten around to it yet? - Christian
Hi, Christian! On Feb 10, Christian Convey wrote:
I was kind of surprised to not find anything in MariaDB's build system for using Doxygen to create HTML docs.
Have people decided this isn't a worthwhile thing to do? Or has just no one gotten around to it yet?
The interest was very low for some reasons. At one point in time there were one or two developers in MySQL who were enthusiastic about it, that's when we've started to use Doxygen style comments (although some functions still have old style comments), and Doxygen docs were generated (once?) and put online somewhere. Then those people left. Others apparently didn't care (myself included). There are few Doxyfiles still in the source tree. And we're still using Doxygen style comments (it doesn't really matter what comment style to use, as long as it's used consistently), so if you'd like you can run Doxygen on that. Regards, Sergei
Thanks Sergei. Once I'm done with the Coverity Scan results, maybe I'll look into adding Doxygen. On the other hand, if no one else really wants it, I might not bother. - Christian On Mon, Feb 11, 2013 at 3:57 AM, Sergei Golubchik <serg@askmonty.org> wrote:
Hi, Christian!
On Feb 10, Christian Convey wrote:
I was kind of surprised to not find anything in MariaDB's build system for using Doxygen to create HTML docs.
Have people decided this isn't a worthwhile thing to do? Or has just no one gotten around to it yet?
The interest was very low for some reasons.
At one point in time there were one or two developers in MySQL who were enthusiastic about it, that's when we've started to use Doxygen style comments (although some functions still have old style comments), and Doxygen docs were generated (once?) and put online somewhere. Then those people left. Others apparently didn't care (myself included). There are few Doxyfiles still in the source tree. And we're still using Doxygen style comments (it doesn't really matter what comment style to use, as long as it's used consistently), so if you'd like you can run Doxygen on that.
Regards, Sergei
Hi!
"Christian" == Christian Convey <christian.convey@gmail.com> writes:
Christian> I was kind of surprised to not find anything in MariaDB's build system Christian> for using Doxygen to create HTML docs. Christian> Have people decided this isn't a worthwhile thing to do? Or has just Christian> no one gotten around to it yet? No one of the current MariaDB developers have had time to do this yet and we haven't had any volunteers that has wanted to do it. That said, a lot of the new code we have produced in MariaDB has Doxygen tags... Regards, Monty
Hi Monty, Thanks. As long as there's something other than a community-wide disinterest in my doing it, I'll keep it on my personal TO DO list. - Christian On Mon, Feb 11, 2013 at 1:30 PM, Michael Widenius <monty@askmonty.org> wrote:
Hi!
"Christian" == Christian Convey <christian.convey@gmail.com> writes:
Christian> I was kind of surprised to not find anything in MariaDB's build system Christian> for using Doxygen to create HTML docs.
Christian> Have people decided this isn't a worthwhile thing to do? Or has just Christian> no one gotten around to it yet?
No one of the current MariaDB developers have had time to do this yet and we haven't had any volunteers that has wanted to do it.
That said, a lot of the new code we have produced in MariaDB has Doxygen tags...
Regards, Monty
participants (3)
-
Christian Convey -
Michael Widenius -
Sergei Golubchik