[mythtv] Documentation

Brad Templeton brad+mydev at templetons.com
Tue Feb 8 00:13:22 UTC 2005

On Mon, Feb 07, 2005 at 09:24:57AM -0500, Daniel Thor Kristjansson wrote:
> On Sun, 6 Feb 2005, Nav Jagpal wrote:
> ]Is there a need for any type of documentation, manuals, etc? 
> There is a need for developer documentation. Starting with a guide to 
> theming and a guide to producing a debug build and a backtrace for bug 
> reporting. But we also need an overview of the classes and how they 
> interact and something like doxygen for the code itself.

When I started looking at the code I would have loved to have seen
docs on the scheduler, on the frontend protocol.   Also, significant
sections of the code are uncommented beyond having descriptive symbol
names -- so adding comments to variable names and function names would
be an important part of documenting the classes.

As for user docs, one start is reading mythtv-users mailing list and
seeing what things people are asking the most questions about.  In some
cases it is undocumented stuff, in other cases it is documented but
they are not finding the documentation.   In the latter case, it's
a challenge to reorganize those docs so that even an idiot can find the
answer to their question.

There are also many levels of users, and as Mythtv grows in popularity,
you will see more users who need to be walked through things, folks who
are less linux-familiar etc.

More information about the mythtv-dev mailing list