[mythtv] mythtv- code architecture

[Colin Guthrie]

Daniel Kristjansson wrote:
> On Wed, 2007-06-13 at 15:20 -0400, hendrixski wrote:
>> Good documentation lowers the barrier to entry for new developers who
>> can make solid contributions.  Making that documentation easily
>> accessible wouldn't be a bad idea either.
> 
> If you write any developer docs, doxygen or any other type,
> I'll be glad to commit these to the tree and mirror the
> results of 'cd mythtv/docs; make devdocs' at cuymedia.net.
> 
> I think writing developer documentation for MythTV is a good
> way to learn the code.

I'm not sure if this is useful or not but on the Digikam list recently I
read the following mail.

Digikam's lead developer Gilles experimented with extending what the
Doxygen docs generated to create better class diagrams etc.

It takse a long time to generate them and I'd imagine doing the same for
Myth would also take >1hr!

May be worth someone playing around.

PS Sorry if the Myth Doxygen stuff already does this, but I've not
looked for a while.

Also, are you aware there is a Trac plugin for Doxygen docs.... may be a
useful addition to add to Myth's site. Works quite nicely if you care to
style it a little (integrated search bit is nice!)

Anyway here is Gilles' mail, hope it's insightful!

Col

> Yesterday, by IRC, Adrien Nicolas Bernhardt, a new developper witch work on a new Image Editor plugin, ask me how to generate the digiKam API documentation.
> 
> On the web site the link to KDE web site where is auto-generated the API-DOC is completly out of date :
> 
> http://developer.kde.org/documentation/library/3.5-api/extragear-graphics-apidocs/digikam/digikam/html
> 
> Today, i have played with Doxygen with is used to generate API documentation. I have set Doxygen to use Graphiz and provide UML diagrams. You can see examples here :
> 
> http://digikam3rdparty.free.fr/API_DOC/html/classDigikam_1_1DImg.html
> 
> http://digikam3rdparty.free.fr/API_DOC/html/inherits.html
> 
> Not all diagrams are generated, because it take a while. Just to generate this documentation, my Double core PIV 1.6 Ghz have take around 90 mns...
> 
> The doxygen config file is on "project" sub-folder from svn. Just go to this forder and run doxygen as well... and take a coffee (:=)))
> 
> You can set more UML diagrams with Kdevelop witch have a config GUI for Doxygen. Just go to "Project/Project Options" menu entry and select "Doxgen" tag on the left. All advanced diagrams settings are in "Dot" tab from the top of config dialog...
> 
> Few days ago, Brian Remedios have posted a messages about UML diagrams generated with a proprietary program. I think than Doxygen + Graphiz are enough here, especially to forget proprietary programs to do it in opensource project (:=)))
> 
> I hope than it can help future contributors...
> 
> Gilles



-- 

+------------------------+
|     Colin Guthrie      |
+------------------------+
| myth(at)colin.guthr.ie |
| http://colin.guthr.ie/ |
+------------------------+